From b37e4260c12606047b2ef2798f350b5315b6da20 Mon Sep 17 00:00:00 2001 From: Hayden Baker Date: Fri, 25 Apr 2025 14:43:59 -0700 Subject: [PATCH 1/2] Update smithy version to be a range in versions-catalog --- gradle/libs.versions.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 98cba25d..089f8656 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,5 +1,5 @@ [versions] -smithy = "1.56.0" +smithy = "[1.0,2.0[" smithy-gradle-plugins = "1.2.0" jreleaser = "1.17.0" From f4646728c8a854c815323487a19551bc130b8200 Mon Sep 17 00:00:00 2001 From: Hayden Baker Date: Fri, 25 Apr 2025 14:46:10 -0700 Subject: [PATCH 2/2] sync models --- .../2019-11-01/accessanalyzer-2019-11-01.json | 76 +- .../2021-02-01/account-2021-02-01.json | 291 +- amp/service/2020-08-01/amp-2020-08-01.json | 346 +- .../application-auto-scaling-2016-02-06.json | 82 +- .../application-signals-2024-04-15.json | 117 + .../2020-05-15/apprunner-2020-05-15.json | 6 + .../2017-07-25/appsync-2017-07-25.json | 129 + .../arc-zonal-shift-2022-10-30.json | 10 +- .../2011-01-01/auto-scaling-2011-01-01.json | 4 +- .../2023-06-05/bedrock-agent-2023-06-05.json | 12 + .../bedrock-data-automation-2023-07-26.json | 111 + .../bedrock-runtime-2023-09-30.json | 382 +- .../2023-04-20/bedrock-2023-04-20.json | 661 +- .../2016-10-20/budgets-2016-10-20.json | 533 +- .../chime-sdk-voice-2022-08-03.json | 9 + .../2022-02-17/cleanrooms-2022-02-17.json | 6 + .../2016-10-06/codebuild-2016-10-06.json | 1125 ++- .../cognito-identity-provider-2016-04-18.json | 232 +- .../connect-contact-lens-2020-08-21.json | 4 +- .../2017-08-08/connect-2017-08-08.json | 153 +- .../2022-10-03/connectcases-2022-10-03.json | 259 +- .../2018-05-10/controlcatalog-2018-05-10.json | 102 + .../2017-10-25/cost-explorer-2017-10-25.json | 32 +- .../cost-optimization-hub-2022-07-26.json | 490 +- .../2018-05-10/datazone-2018-05-10.json | 2 +- .../2023-10-12/deadline-2023-10-12.json | 116 +- .../2018-10-26/detective-2018-10-26.json | 974 +- .../directory-service-data-2023-05-31.json | 454 +- dsql/service/2018-05-10/dsql-2018-05-10.json | 113 +- .../2012-08-10/dynamodb-2012-08-10.json | 57 +- ec2/service/2016-11-15/ec2-2016-11-15.json | 2281 ++++- ecr/service/2015-09-21/ecr-2015-09-21.json | 8 +- ecs/service/2014-11-13/ecs-2014-11-13.json | 176 +- eks/service/2017-11-01/eks-2017-11-01.json | 31 +- .../2015-02-02/elasticache-2015-02-02.json | 34 +- .../entityresolution-2018-05-10.json | 71 +- .../2015-10-07/eventbridge-2015-10-07.json | 99 +- .../2015-08-04/firehose-2015-08-04.json | 2 +- glue/service/2017-03-31/glue-2017-03-31.json | 77 +- .../2019-05-23/groundstation-2019-05-23.json | 811 +- .../2021-06-17/iotfleetwise-2021-06-17.json | 82 +- .../2020-08-07/lex-models-v2-2020-08-07.json | 116 + m2/service/2021-04-28/m2-2021-04-28.json | 494 + .../2023-10-17/mailmanager-2023-10-17.json | 165 +- .../marketplace-deployment-2023-01-25.json | 8 +- ...tplace-entitlement-service-2017-01-11.json | 656 +- .../marketplace-metering-2016-01-14.json | 90 +- .../2017-10-14/medialive-2017-10-14.json | 1052 +++ .../2018-04-23/mediatailor-2018-04-23.json | 238 +- .../2021-01-01/memorydb-2021-01-01.json | 98 +- mq/service/2017-11-27/mq-2017-11-27.json | 68 + .../service/2022-11-28/omics-2022-11-28.json | 1362 ++- .../2021-01-01/opensearch-2021-01-01.json | 178 +- .../2019-12-03/outposts-2019-12-03.json | 53 +- pcs/service/2023-02-10/pcs-2023-02-10.json | 10 +- .../2018-05-22/personalize-2018-05-22.json | 87 +- .../2023-11-27/qbusiness-2023-11-27.json | 1165 ++- .../2020-10-19/qconnect-2020-10-19.json | 126 +- .../2018-04-01/quicksight-2018-04-01.json | 64 + rds/service/2014-10-31/rds-2014-10-31.json | 95 +- .../redshift-serverless-2021-04-21.json | 575 +- .../resource-explorer-2-2022-07-28.json | 9 +- .../resource-groups-2017-11-27.json | 25 +- .../2013-04-01/route-53-2013-04-01.json | 12 + .../2018-08-20/s3-control-2018-08-20.json | 5192 ++++++---- s3/service/2006-03-01/s3-2006-03-01.json | 8329 +++++++++++------ .../2018-05-10/s3tables-2018-05-10.json | 445 +- .../2017-07-24/sagemaker-2017-07-24.json | 169 +- .../2018-10-26/securityhub-2018-10-26.json | 14 +- .../service-catalog-2015-12-10.json | 2 +- .../2019-06-24/service-quotas-2019-06-24.json | 71 +- .../service/2019-09-27/sesv2-2019-09-27.json | 159 +- .../storage-gateway-2013-06-30.json | 21 +- .../2018-05-10/taxsettings-2018-05-10.json | 138 +- .../2017-10-26/transcribe-2017-10-26.json | 6 + .../2018-11-05/transfer-2018-11-05.json | 976 +- .../verifiedpermissions-2021-12-01.json | 56 + 77 files changed, 25422 insertions(+), 7462 deletions(-) diff --git a/accessanalyzer/service/2019-11-01/accessanalyzer-2019-11-01.json b/accessanalyzer/service/2019-11-01/accessanalyzer-2019-11-01.json index 60b5b49f..0494f589 100644 --- a/accessanalyzer/service/2019-11-01/accessanalyzer-2019-11-01.json +++ b/accessanalyzer/service/2019-11-01/accessanalyzer-2019-11-01.json @@ -1254,6 +1254,38 @@ { "value": "AWS::IAM::AssumeRolePolicyDocument", "name": "ROLE_TRUST" + }, + { + "value": "AWS::S3Tables::TableBucket", + "name": "S3_TABLE_BUCKET" + }, + { + "value": "AWS::ApiGateway::RestApi", + "name": "API_GATEWAY_REST_API" + }, + { + "value": "AWS::CodeArtifact::Domain", + "name": "CODE_ARTIFACT_DOMAIN" + }, + { + "value": "AWS::Backup::BackupVault", + "name": "BACKUP_VAULT" + }, + { + "value": "AWS::CloudTrail::Dashboard", + "name": "CLOUDTRAIL_DASHBOARD" + }, + { + "value": "AWS::CloudTrail::EventDataStore", + "name": "CLOUDTRAIL_EVENT_DATA_STORE" + }, + { + "value": "AWS::S3Tables::Table", + "name": "S3_TABLE" + }, + { + "value": "AWS::S3Express::AccessPoint", + "name": "S3_EXPRESS_ACCESS_POINT" } ] } @@ -6297,7 +6329,7 @@ } }, "traits": { - "smithy.api#documentation": "

The proposed InternetConfiguration or VpcConfiguration to\n apply to the Amazon S3 access point. VpcConfiguration does not apply to\n multi-region access points. You can make the access point accessible from the internet, or\n you can specify that all requests made through that access point must originate from a\n specific virtual private cloud (VPC). You can specify only one type of network\n configuration. For more information, see Creating access\n points.

" + "smithy.api#documentation": "

The proposed InternetConfiguration or VpcConfiguration to\n apply to the Amazon S3 access point. You can make the access point accessible from the internet,\n or you can specify that all requests made through that access point must originate from a\n specific virtual private cloud (VPC). You can specify only one type of network\n configuration. For more information, see Creating access\n points.

" } }, "com.amazonaws.accessanalyzer#OrderBy": { @@ -6934,7 +6966,7 @@ "networkOrigin": { "target": "com.amazonaws.accessanalyzer#NetworkOriginConfiguration", "traits": { - "smithy.api#documentation": "

The proposed Internet and VpcConfiguration to apply to this\n Amazon S3 access point. VpcConfiguration does not apply to multi-region access\n points. If the access preview is for a new resource and neither is specified, the access\n preview uses Internet for the network origin. If the access preview is for an\n existing resource and neither is specified, the access preview uses the exiting network\n origin.

" + "smithy.api#documentation": "

The proposed Internet and VpcConfiguration to apply to this\n Amazon S3 access point. VpcConfiguration does not apply to multi-region access\n points. If the access preview is for a new resource and neither is specified, the access\n preview uses Internet for the network origin. If the access preview is for an\n existing resource and neither is specified, the access preview uses the existing network\n origin.

" } } }, @@ -7014,6 +7046,38 @@ "com.amazonaws.accessanalyzer#S3BucketPolicy": { "type": "string" }, + "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[^:]*:s3express:[^:]*:[^:]*:accesspoint/.*$" + } + }, + "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointConfiguration": { + "type": "structure", + "members": { + "accessPointPolicy": { + "target": "com.amazonaws.accessanalyzer#AccessPointPolicy", + "traits": { + "smithy.api#documentation": "

The proposed access point policy for an Amazon S3 directory bucket access point.

" + } + }, + "networkOrigin": { + "target": "com.amazonaws.accessanalyzer#NetworkOriginConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Proposed configuration for an access point attached to an Amazon S3 directory bucket. You can\n propose up to 10 access points per bucket. If the proposed access point configuration is\n for an existing Amazon S3 directory bucket, the access preview uses the proposed access point\n configuration in place of the existing access points. To propose an access point without a\n policy, you can provide an empty string as the access point policy. For more information\n about access points for Amazon S3 directory buckets, see Managing access to\n directory buckets with access points in the Amazon Simple Storage Service User Guide.

" + } + }, + "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointConfigurationsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointArn" + }, + "value": { + "target": "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointConfiguration" + } + }, "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketConfiguration": { "type": "structure", "members": { @@ -7022,10 +7086,16 @@ "traits": { "smithy.api#documentation": "

The proposed bucket policy for the Amazon S3 directory bucket.

" } + }, + "accessPoints": { + "target": "com.amazonaws.accessanalyzer#S3ExpressDirectoryAccessPointConfigurationsMap", + "traits": { + "smithy.api#documentation": "

The proposed access points for the Amazon S3 directory bucket.

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

Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about Amazon S3 directory bucket policies, see\n Example directory bucket policies for S3 Express One Zone.

" + "smithy.api#documentation": "

Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about Amazon S3 directory bucket policies, see\n Example bucket policies for directory buckets in the Amazon Simple Storage Service User\n Guide.

" } }, "com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketPolicy": { diff --git a/account/service/2021-02-01/account-2021-02-01.json b/account/service/2021-02-01/account-2021-02-01.json index 389b6171..d2dfd3f0 100644 --- a/account/service/2021-02-01/account-2021-02-01.json +++ b/account/service/2021-02-01/account-2021-02-01.json @@ -30,7 +30,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known\n as the root user email address) for the specified account.

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

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.

", "smithy.api#http": { "uri": "/acceptPrimaryEmailUpdate", "method": "POST", @@ -44,21 +44,21 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

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

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

The management account can't specify its own AccountId.

", "smithy.api#required": {} } }, "PrimaryEmail": { "target": "com.amazonaws.account#PrimaryEmailAddress", "traits": { - "smithy.api#documentation": "

The new primary email address for use with the specified account. This must\n match the PrimaryEmail from the StartPrimaryEmailUpdate API\n call.

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

The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.

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

The OTP code sent to the PrimaryEmail specified on the\n StartPrimaryEmailUpdate API call.

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

The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.

", "smithy.api#required": {} } } @@ -89,10 +89,17 @@ "traits": { "smithy.api#required": {} } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value populated to the x-amzn-ErrorType response header by API Gateway.

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } } }, "traits": { - "smithy.api#documentation": "

The operation failed because the calling identity doesn't have the minimum required\n permissions.

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

The operation failed because the calling identity doesn't have the minimum required permissions.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -101,6 +108,9 @@ "type": "service", "version": "2021-02-01", "resources": [ + { + "target": "com.amazonaws.account#AccountNameResource" + }, { "target": "com.amazonaws.account#AlternateContactResource" }, @@ -1064,12 +1074,43 @@ } } }, + "com.amazonaws.account#AccountCreatedDate": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.account#AccountId": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{12}$" } }, + "com.amazonaws.account#AccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[ -;=?-~]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.account#AccountNameResource": { + "type": "resource", + "put": { + "target": "com.amazonaws.account#PutAccountName" + }, + "read": { + "target": "com.amazonaws.account#GetAccountInformation" + }, + "traits": { + "aws.api#arn": { + "template": "AccountName" + } + } + }, "com.amazonaws.account#AddressLine": { "type": "string", "traits": { @@ -1115,7 +1156,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that contains the details of an alternate contact associated with an Amazon Web Services\n account

" + "smithy.api#documentation": "

A structure that contains the details of an alternate contact associated with an Amazon Web Services account

" } }, "com.amazonaws.account#AlternateContactResource": { @@ -1187,10 +1228,17 @@ "traits": { "smithy.api#required": {} } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value populated to the x-amzn-ErrorType response header by API Gateway.

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } } }, "traits": { - "smithy.api#documentation": "

The request could not be processed because of a conflict in the current status of the\n resource. For example, this happens if you try to enable a Region that is currently being disabled\n (in a status of DISABLING).

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

The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING) or if you try to change an account\u2019s root user email to an email address which is already in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1234,7 +1282,7 @@ "StateOrRegion": { "target": "com.amazonaws.account#StateOrRegion", "traits": { - "smithy.api#documentation": "

The state or region of the primary contact address. If the mailing address is within the United States (US), the\n value in this field can be either a two character state code (for example, NJ) or the full state name\n (for example, New Jersey). This field is required in the following countries: US,\n CA, GB, DE, JP, IN,\n and BR.

" + "smithy.api#documentation": "

The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, NJ) or the full state name (for example, New Jersey). This field is required in the following countries: US, CA, GB, DE, JP, IN, and BR.

" } }, "DistrictOrCounty": { @@ -1260,14 +1308,14 @@ "PhoneNumber": { "target": "com.amazonaws.account#ContactInformationPhoneNumber", "traits": { - "smithy.api#documentation": "

The phone number of the primary contact information. The number will be validated and,\n in some countries, checked for activation.

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

The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

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

The name of the company associated with the primary contact information, if\n any.

" + "smithy.api#documentation": "

The name of the company associated with the primary contact information, if any.

" } }, "WebsiteUrl": { @@ -1278,7 +1326,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

" + "smithy.api#documentation": "

Contains the details of the primary contact information associated with an Amazon Web Services account.

" } }, "com.amazonaws.account#ContactInformationPhoneNumber": { @@ -1342,7 +1390,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alternate contact from an Amazon Web Services account.

\n

For complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.

\n \n

Before you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.

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

Deletes the specified alternate contact from an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.

", "smithy.api#http": { "uri": "/deleteAlternateContact", "method": "POST", @@ -1364,7 +1412,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.

\n

If you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.

\n

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n Account Management service, and optionally a delegated admin account \n assigned.

\n \n

The management account can't specify its own AccountId; it must call\n the operation in standalone context by not including the AccountId \n parameter.

\n \n

To call this operation on an account that is not a member of an organization, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

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

Disables (opts-out) a particular Region for an account.

\n \n

The act of disabling a Region will remove all IAM access to any resources that\n reside in that Region.

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

Disables (opts-out) a particular Region for an account.

The act of disabling a Region will remove all IAM access to any resources that reside in that Region.

", "smithy.api#http": { "uri": "/disableRegion", "method": "POST", @@ -1412,13 +1460,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example,\n af-south-1). When you disable a Region, Amazon Web Services performs actions to\n deactivate that Region in your account, such as destroying IAM resources in the Region.\n This process takes a few minutes for most accounts, but this can take several hours. You\n cannot enable the Region until the disabling process is fully completed.

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

Specifies the Region-code for a given Region name (for example, af-south-1). When you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.

", "smithy.api#required": {} } } @@ -1488,13 +1536,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example,\n af-south-1). When you enable a Region, Amazon Web Services performs actions to\n prepare your account in that Region, such as distributing your IAM resources to the\n Region. This process takes a few minutes for most accounts, but it can take several\n hours. You cannot use the Region until this process is complete. Furthermore, you cannot\n disable the Region until the enabling process is fully completed.

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

Specifies the Region-code for a given Region name (for example, af-south-1). When you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such as distributing your IAM resources to the Region. This process takes a few minutes for most accounts, but it can take several hours. You cannot use the Region until this process is complete. Furthermore, you cannot disable the Region until the enabling process is fully completed.

", "smithy.api#required": {} } } @@ -1513,6 +1561,81 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#GetAccountInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#GetAccountInformationRequest" + }, + "output": { + "target": "com.amazonaws.account#GetAccountInformationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the specified account including its account name, account ID, and account creation date and time. To use this API, an IAM user or role must have the account:GetAccountInformation IAM permission.

", + "smithy.api#http": { + "uri": "/getAccountInformation", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.account#GetAccountInformationRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#GetAccountInformationResponse": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

The management account can't specify its own AccountId.

" + } + }, + "AccountName": { + "target": "com.amazonaws.account#AccountName", + "traits": { + "smithy.api#documentation": "

The name of the account.

" + } + }, + "AccountCreatedDate": { + "target": "com.amazonaws.account#AccountCreatedDate", + "traits": { + "smithy.api#documentation": "

The date and time the account was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#GetAlternateContact": { "type": "operation", "input": { @@ -1539,7 +1662,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the specified alternate contact attached to an Amazon Web Services account.

\n

For complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.

\n \n

Before you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.

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

Retrieves the specified alternate contact attached to an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.

", "smithy.api#http": { "uri": "/getAlternateContact", "method": "POST", @@ -1564,7 +1687,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.

\n

If you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.

\n

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n Account Management service, and optionally a delegated admin account \n assigned.

\n \n

The management account can't specify its own AccountId; it must call\n the operation in standalone context by not including the AccountId \n parameter.

\n \n

To call this operation on an account that is not a member of an organization, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

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

Retrieves the primary contact information of an Amazon Web Services account.

\n

For complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.

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

Retrieves the primary contact information of an Amazon Web Services account.

For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.

", "smithy.api#http": { "uri": "/getContactInformation", "method": "POST", @@ -1630,7 +1753,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" } } }, @@ -1644,7 +1767,7 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

" + "smithy.api#documentation": "

Contains the details of the primary contact information associated with an Amazon Web Services account.

" } } }, @@ -1696,7 +1819,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

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

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

The management account can't specify its own AccountId.

", "smithy.api#required": {} } } @@ -1711,7 +1834,7 @@ "PrimaryEmail": { "target": "com.amazonaws.account#PrimaryEmailAddress", "traits": { - "smithy.api#documentation": "

Retrieves the primary email address associated with the specified\n account.

" + "smithy.api#documentation": "

Retrieves the primary email address associated with the specified account.

" } } }, @@ -1760,13 +1883,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example,\n af-south-1). This function will return the status of whatever Region\n you pass into this parameter.

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

Specifies the Region-code for a given Region name (for example, af-south-1). This function will return the status of whatever Region you pass into this parameter.

", "smithy.api#required": {} } } @@ -1787,7 +1910,7 @@ "RegionOptStatus": { "target": "com.amazonaws.account#RegionOptStatus", "traits": { - "smithy.api#documentation": "

One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled,\n Disabling, Enabled_By_Default).

" + "smithy.api#documentation": "

One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).

" } } }, @@ -1803,10 +1926,17 @@ "traits": { "smithy.api#required": {} } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value populated to the x-amzn-ErrorType response header by API Gateway.

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } } }, "traits": { - "smithy.api#documentation": "

The operation failed because of an error internal to Amazon Web Services. Try your operation again\n later.

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

The operation failed because of an error internal to Amazon Web Services. Try your operation again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -1835,7 +1965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the Regions for a given account and their respective opt-in statuses.\n Optionally, this list can be filtered by the region-opt-status-contains\n parameter.

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

Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.

", "smithy.api#http": { "uri": "/listRegions", "method": "POST", @@ -1859,13 +1989,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

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

The total number of items to return in the command\u2019s output. If the total number of\n items available is more than the value specified, a NextToken is provided\n in the command\u2019s output. To resume pagination, provide the NextToken value\n in the starting-token argument of a subsequent command. Do not use the\n NextToken response element directly outside of the Amazon Web Services CLI. For usage\n examples, see Pagination in the Amazon Web Services Command Line Interface User\n Guide.

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

The total number of items to return in the command\u2019s output. If the total number of items available is more than the value specified, a NextToken is provided in the command\u2019s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

", "smithy.api#range": { "min": 1, "max": 50 @@ -1875,7 +2005,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used to specify where to start paginating. This is the NextToken\n from a previously truncated response. For usage examples, see Pagination in the\n Amazon Web Services Command Line Interface User Guide.

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

A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

", "smithy.api#length": { "max": 1000 } @@ -1884,7 +2014,7 @@ "RegionOptStatusContains": { "target": "com.amazonaws.account#RegionOptStatusList", "traits": { - "smithy.api#documentation": "

A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default)\n to use to filter the list of Regions for a given account. For example, passing in a\n value of ENABLING will only return a list of Regions with a Region status of\n ENABLING.

" + "smithy.api#documentation": "

A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

" } } }, @@ -1898,13 +2028,13 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If there is more data to be returned, this will be populated. It should be passed into\n the next-token request parameter of list-regions.

" + "smithy.api#documentation": "

If there is more data to be returned, this will be populated. It should be passed into the next-token request parameter of list-regions.

" } }, "Regions": { "target": "com.amazonaws.account#RegionOptList", "traits": { - "smithy.api#documentation": "

This is a list of Regions for a given account, or if the filtered parameter was used,\n a list of Regions that match the filter criteria set in the filter\n parameter.

" + "smithy.api#documentation": "

This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the filter parameter.

" } } }, @@ -1994,6 +2124,59 @@ ] } }, + "com.amazonaws.account#PutAccountName": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#PutAccountNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.

", + "smithy.api#http": { + "uri": "/putAccountName", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.account#PutAccountNameRequest": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.account#AccountName", + "traits": { + "smithy.api#documentation": "

The name of the account.

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

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.account#PutAlternateContact": { "type": "operation", "input": { @@ -2017,7 +2200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the specified alternate contact attached to an Amazon Web Services account.

\n

For complete details about how to use the alternate contact operations, see Access or\n updating the alternate contacts.

\n \n

Before you can update the alternate contact information for an \n Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management\n and Organizations. For more information, see Enabling trusted access for \n Amazon Web Services Account Management.

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

Modifies the specified alternate contact attached to an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.

", "smithy.api#http": { "uri": "/putAlternateContact", "method": "POST", @@ -2067,7 +2250,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that \n you want to access or modify with this operation.

\n

If you do not specify this parameter, it defaults to the Amazon Web Services account of the \n identity used to call the operation.

\n

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and \n the specified account ID must be a member account in the same organization. The\n organization must have all features \n enabled, and the organization must have trusted access enabled for the \n Account Management service, and optionally a delegated admin account \n assigned.

\n \n

The management account can't specify its own AccountId; it must call\n the operation in standalone context by not including the AccountId \n parameter.

\n \n

To call this operation on an account that is not a member of an organization, then \n don't specify this parameter, and call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

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

Updates the primary contact information of an Amazon Web Services account.

\n

For complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.

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

Updates the primary contact information of an Amazon Web Services account.

For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.

", "smithy.api#http": { "uri": "/putContactInformation", "method": "POST", @@ -2113,14 +2296,14 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

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

Contains the details of the primary contact information associated with an Amazon Web Services account.

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

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n \n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

" } } }, @@ -2140,12 +2323,12 @@ "RegionOptStatus": { "target": "com.amazonaws.account#RegionOptStatus", "traits": { - "smithy.api#documentation": "

One of potential statuses a Region can undergo (Enabled, Enabling, Disabled,\n Disabling, Enabled_By_Default).

" + "smithy.api#documentation": "

One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).

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

This is a structure that expresses the Region for a given account, consisting of a\n name and opt-in status.

" + "smithy.api#documentation": "

This is a structure that expresses the Region for a given account, consisting of a name and opt-in status.

" } }, "com.amazonaws.account#RegionName": { @@ -2226,6 +2409,13 @@ "traits": { "smithy.api#required": {} } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value populated to the x-amzn-ErrorType response header by API Gateway.

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } } }, "traits": { @@ -2269,7 +2459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the process to update the primary email address for the specified\n account.

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

Starts the process to update the primary email address for the specified account.

", "smithy.api#http": { "uri": "/startPrimaryEmailUpdate", "method": "POST", @@ -2283,14 +2473,14 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

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

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

The management account can't specify its own AccountId.

", "smithy.api#required": {} } }, "PrimaryEmail": { "target": "com.amazonaws.account#PrimaryEmailAddress", "traits": { - "smithy.api#documentation": "

The new primary email address (also known as the root user email address) to\n use in the specified account.

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

The new primary email address (also known as the root user email address) to use in the specified account.

", "smithy.api#required": {} } } @@ -2341,10 +2531,17 @@ "traits": { "smithy.api#required": {} } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value populated to the x-amzn-ErrorType response header by API Gateway.

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } } }, "traits": { - "smithy.api#documentation": "

The operation failed because it was called too frequently and exceeded a throttle\n limit.

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

The operation failed because it was called too frequently and exceeded a throttle limit.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { diff --git a/amp/service/2020-08-01/amp-2020-08-01.json b/amp/service/2020-08-01/amp-2020-08-01.json index 77fb2332..f519dcbc 100644 --- a/amp/service/2020-08-01/amp-2020-08-01.json +++ b/amp/service/2020-08-01/amp-2020-08-01.json @@ -1405,7 +1405,7 @@ "roleConfiguration": { "target": "com.amazonaws.amp#RoleConfiguration", "traits": { - "smithy.api#documentation": "

The scraper role configuration for the workspace.

" + "smithy.api#documentation": "

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

" } }, "clientToken": { @@ -2384,6 +2384,72 @@ } } }, + "com.amazonaws.amp#DescribeWorkspaceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DescribeWorkspaceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#DescribeWorkspaceConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ThrottlingException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to return information about the configuration of a workspace. The configuration details\n returned include workspace configuration status, label set limits, and retention period.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/workspaces/{workspaceId}/configuration" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amp#DescribeWorkspaceConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use \n the ListWorkspaces operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amp#DescribeWorkspaceConfigurationResponse": { + "type": "structure", + "members": { + "workspaceConfiguration": { + "target": "com.amazonaws.amp#WorkspaceConfigurationDescription", + "traits": { + "smithy.api#documentation": "

This structure contains the information about the workspace configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amp#DescribeWorkspaceRequest": { "type": "structure", "members": { @@ -2612,6 +2678,77 @@ "smithy.api#pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/[-a-f0-9]+$" } }, + "com.amazonaws.amp#LabelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.amp#LabelSet": { + "type": "map", + "key": { + "target": "com.amazonaws.amp#LabelName" + }, + "value": { + "target": "com.amazonaws.amp#LabelValue" + } + }, + "com.amazonaws.amp#LabelValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.amp#LimitsPerLabelSet": { + "type": "structure", + "members": { + "limits": { + "target": "com.amazonaws.amp#LimitsPerLabelSetEntry", + "traits": { + "smithy.api#documentation": "

This structure contains the information about the limits that apply to time series that match this label set.

", + "smithy.api#required": {} + } + }, + "labelSet": { + "target": "com.amazonaws.amp#LabelSet", + "traits": { + "smithy.api#documentation": "

This defines one label set that will have an enforced ingestion limit.

\n

Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. \n If the label name is metric name label __name__, then the metric part of the name\n must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*\n

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

This structure defines one label set used to enforce ingestion limits for the workspace, and defines the limit for that label set.

\n

A label set is\n a unique combination of label-value pairs. Use them to control time series ingestion limits and to monitor usage by specific label groups.\n Example label sets might be team:finance or env:prod\n

" + } + }, + "com.amazonaws.amp#LimitsPerLabelSetEntry": { + "type": "structure", + "members": { + "maxSeries": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The maximum number of active series that can be ingested that match this label set.

\n

Setting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed Service for Prometheus to vend label set metrics to CloudWatch

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

This structure contains the information about the limits that apply to time series that match one label set.

" + } + }, + "com.amazonaws.amp#LimitsPerLabelSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.amp#LimitsPerLabelSet" + } + }, "com.amazonaws.amp#ListRuleGroupsNamespaces": { "type": "operation", "input": { @@ -3465,18 +3602,18 @@ "sourceRoleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "

A ARN identifying the source role configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role used in the source account to enable cross-account scraping. For information about\n the contents of this policy, see Cross-account setup.

" } }, "targetRoleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "

A ARN identifying the target role configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role used in the target account to enable cross-account scraping. For information about\n the contents of this policy, see Cross-account setup.

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

To configure roles that allows users to write to an Amazon Managed Service for Prometheus workspace in a different account.

" + "smithy.api#documentation": "

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

" } }, "com.amazonaws.amp#RuleGroupsNamespace": { @@ -3862,7 +3999,10 @@ } }, "roleConfiguration": { - "target": "com.amazonaws.amp#RoleConfiguration" + "target": "com.amazonaws.amp#RoleConfiguration", + "traits": { + "smithy.api#documentation": "

This structure displays information about the IAM roles used for cross-account scraping configuration.

" + } } }, "traits": { @@ -4043,7 +4183,10 @@ } }, "roleConfiguration": { - "target": "com.amazonaws.amp#RoleConfiguration" + "target": "com.amazonaws.amp#RoleConfiguration", + "traits": { + "smithy.api#documentation": "

This structure displays information about the IAM roles used for cross-account scraping configuration.

" + } } }, "traits": { @@ -4562,7 +4705,7 @@ "roleConfiguration": { "target": "com.amazonaws.amp#RoleConfiguration", "traits": { - "smithy.api#documentation": "

The scraper role configuration for the workspace.

" + "smithy.api#documentation": "

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

" } }, "clientToken": { @@ -4682,6 +4825,100 @@ "smithy.api#documentation": "

Represents the input of an UpdateWorkspaceAlias operation.

" } }, + "com.amazonaws.amp#UpdateWorkspaceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#UpdateWorkspaceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#UpdateWorkspaceConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.amp#ThrottlingException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

\n

You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the\n request to be valid.

", + "smithy.api#http": { + "code": 202, + "method": "PATCH", + "uri": "/workspaces/{workspaceId}/configuration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#UpdateWorkspaceConfigurationRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of the workspace that you want to update. To find the IDs of your workspaces, use \n the ListWorkspaces operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

You can include a token in your operation to make it an idempotent opeartion.

", + "smithy.api#idempotencyToken": {} + } + }, + "limitsPerLabelSet": { + "target": "com.amazonaws.amp#LimitsPerLabelSetList", + "traits": { + "smithy.api#documentation": "

This is an array of structures, where each structure defines a label set for the workspace, and \n defines the ingestion limit for active time series for each of those label sets. Each label name in a label set must be unique.

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

Specifies how many days that metrics will be retained in the workspace.

", + "smithy.api#range": { + "min": 1 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amp#UpdateWorkspaceConfigurationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#WorkspaceConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the workspace configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amp#Uri": { "type": "string", "traits": { @@ -4807,6 +5044,9 @@ }, { "target": "com.amazonaws.amp#RuleGroupsNamespace" + }, + { + "target": "com.amazonaws.amp#WorkspaceConfiguration" } ], "traits": { @@ -4838,6 +5078,98 @@ "smithy.api#pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$" } }, + "com.amazonaws.amp#WorkspaceConfiguration": { + "type": "resource", + "identifiers": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId" + } + }, + "read": { + "target": "com.amazonaws.amp#DescribeWorkspaceConfiguration" + }, + "update": { + "target": "com.amazonaws.amp#UpdateWorkspaceConfiguration" + }, + "traits": { + "aws.api#arn": { + "template": "workspace/{workspaceId}" + } + } + }, + "com.amazonaws.amp#WorkspaceConfigurationDescription": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#WorkspaceConfigurationStatus", + "traits": { + "smithy.api#documentation": "

This structure displays the current status of the workspace configuration, and might also contain a reason for that status.

", + "smithy.api#required": {} + } + }, + "limitsPerLabelSet": { + "target": "com.amazonaws.amp#LimitsPerLabelSetList", + "traits": { + "smithy.api#documentation": "

This is an array of structures, where each structure displays one label sets for the workspace and the limits for that label set.

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

This field displays how many days that metrics are retained in the workspace.

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

This structure contains the description of the workspace configuration.

" + } + }, + "com.amazonaws.amp#WorkspaceConfigurationStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.amp#WorkspaceConfigurationStatusCode", + "traits": { + "smithy.api#documentation": "

The current status of the workspace configuration.

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

The reason for the current status, if a reason is available.

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

This structure displays the current status of the workspace configuration, and might also contain a reason for that status.

" + } + }, + "com.amazonaws.amp#WorkspaceConfigurationStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "Workspace configuration has been updated. Update is disallowed until workspace configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "UPDATING", + "value": "UPDATING", + "documentation": "Workspace configuration is being updated. Update is disallowed until workspace configuration is ACTIVE and workspace status is ACTIVE." + }, + { + "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", + "documentation": "Workspace configuration update failed." + } + ] + } + }, "com.amazonaws.amp#WorkspaceDescription": { "type": "structure", "members": { diff --git a/application-auto-scaling/service/2016-02-06/application-auto-scaling-2016-02-06.json b/application-auto-scaling/service/2016-02-06/application-auto-scaling-2016-02-06.json index 328a8aad..47480e97 100644 --- a/application-auto-scaling/service/2016-02-06/application-auto-scaling-2016-02-06.json +++ b/application-auto-scaling/service/2016-02-06/application-auto-scaling-2016-02-06.json @@ -150,7 +150,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

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

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

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n ", "smithy.api#title": "Application Auto Scaling", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1277,14 +1277,14 @@ "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": {} } }, "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": {} } } @@ -1359,14 +1359,14 @@ "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#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": {} } }, "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": {} } } @@ -1433,14 +1433,14 @@ "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": {} } }, "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": {} } } @@ -1543,13 +1543,13 @@ "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.

\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 " } }, "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. If you specify a scalable dimension, you must also specify a resource ID.

\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. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -1661,13 +1661,13 @@ "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.

\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.

\n " } }, "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 " + "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 " } }, "MaxResults": { @@ -1806,13 +1806,13 @@ "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#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n " } }, "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 " + "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 " } }, "MaxResults": { @@ -1942,13 +1942,13 @@ "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#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n " } }, "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 " + "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 " } }, "MaxResults": { @@ -2488,6 +2488,18 @@ "smithy.api#enumValue": "KafkaBrokerStorageUtilization" } }, + "ElastiCacheEngineCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheEngineCPUUtilization" + } + }, + "ElastiCacheDatabaseMemoryUsagePercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheDatabaseMemoryUsagePercentage" + } + }, "ElastiCachePrimaryEngineCPUUtilization": { "target": "smithy.api#Unit", "traits": { @@ -3119,7 +3131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scaling policy applies to the scalable target identified by those three\n attributes. You cannot create a scaling policy until you have registered the resource as a\n scalable target.

\n

Multiple scaling policies can be in force at the same time for the same scalable target.\n You can have one or more target tracking scaling policies, one or more step scaling\n policies, or both. However, there is a chance that multiple policies could conflict,\n instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives\n precedence to the policy that provides the largest capacity for both scale out and scale\n in. For example, if one policy increases capacity by 3, another policy increases capacity\n by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest\n calculated capacity (200% of 10 = 20) and scales out to 30.

\n

We recommend caution, however, when using target tracking scaling policies with step\n scaling policies because conflicts between these policies can cause undesirable behavior.\n For example, if the step scaling policy initiates a scale-in activity before the target\n tracking policy is ready to scale in, the scale-in activity will not be blocked. After the\n scale-in activity completes, the target tracking policy could instruct the scalable target\n to scale out again.

\n

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n use scaling policies. Any scaling policies that were specified for the scalable target\n are deleted.

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

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scaling policy applies to the scalable target identified by those three\n attributes. You cannot create a scaling policy until you have registered the resource as a\n scalable target.

\n

Multiple scaling policies can be in force at the same time for the same scalable target.\n You can have one or more target tracking scaling policies, one or more step scaling\n policies, or both. However, there is a chance that multiple policies could conflict,\n instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives\n precedence to the policy that provides the largest capacity for both scale out and scale\n in. For example, if one policy increases capacity by 3, another policy increases capacity\n by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest\n calculated capacity (200% of 10 = 20) and scales out to 30.

\n

We recommend caution, however, when using target tracking scaling policies with step\n scaling policies because conflicts between these policies can cause undesirable behavior.\n For example, if the step scaling policy initiates a scale-in activity before the target\n tracking policy is ready to scale in, the scale-in activity will not be blocked. After the\n scale-in activity completes, the target tracking policy could instruct the scalable target\n to scale out again.

\n

For more information, see Target tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n use scaling policies. Any scaling policies that were specified for the scalable target\n are deleted.

\n ", "smithy.api#examples": [ { "title": "To apply a target tracking scaling policy with a predefined metric specification", @@ -3176,21 +3188,21 @@ "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#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 ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.applicationautoscaling#PolicyType", "traits": { - "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling\u2014Not supported for Amazon EMR.

\n

\n StepScaling\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

For more information, see Target\n tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling\u2014Not supported for Amazon EMR.

\n

\n StepScaling\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling\u2014Only supported for Amazon ECS.

\n

For more information, see Target\n tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

" } }, "StepScalingPolicyConfiguration": { @@ -3315,14 +3327,14 @@ "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#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": {} } }, "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": {} } }, @@ -3411,14 +3423,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "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 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", "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": {} } }, @@ -3638,6 +3650,12 @@ "smithy.api#enumValue": "kafka:broker-storage:VolumeSize" } }, + "ElastiCacheCacheClusterNodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticache:cache-cluster:Nodes" + } + }, "ElastiCacheReplicationGroupNodeGroups": { "target": "smithy.api#Unit", "traits": { @@ -3689,14 +3707,14 @@ "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": {} } }, "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": {} } }, @@ -3803,14 +3821,14 @@ "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.

\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.

\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 ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -3948,21 +3966,21 @@ "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#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 ", + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.applicationautoscaling#PolicyType", "traits": { - "smithy.api#documentation": "

The scaling policy type.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling\u2014Not supported for Amazon EMR

\n

\n StepScaling\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

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

The scaling policy type.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling\u2014Not supported for Amazon EMR

\n

\n StepScaling\u2014Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling\u2014Only supported for Amazon ECS

", "smithy.api#required": {} } }, @@ -4045,14 +4063,14 @@ "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#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 " + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " } }, "StartTime": { diff --git a/application-signals/service/2024-04-15/application-signals-2024-04-15.json b/application-signals/service/2024-04-15/application-signals-2024-04-15.json index d4005ead..87d17541 100644 --- a/application-signals/service/2024-04-15/application-signals-2024-04-15.json +++ b/application-signals/service/2024-04-15/application-signals-2024-04-15.json @@ -917,6 +917,28 @@ "smithy.api#output": {} } }, + "com.amazonaws.applicationsignals#DependencyConfig": { + "type": "structure", + "members": { + "DependencyKeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n ", + "smithy.api#required": {} + } + }, + "DependencyOperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

The name of the called operation in the dependency.

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

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

\n

When creating a service dependency SLO, you must specify the KeyAttributes of the service, and the DependencyConfig for the dependency. You can specify the OperationName of the service, from which it calls the dependency. Alternatively, \n you can exclude OperationName and the SLO will monitor all of the service's operations that call the dependency.

" + } + }, "com.amazonaws.applicationsignals#Dimension": { "type": "structure", "members": { @@ -1700,6 +1722,12 @@ "smithy.api#httpQuery": "OperationName" } }, + "DependencyConfig": { + "target": "com.amazonaws.applicationsignals#DependencyConfig", + "traits": { + "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

" + } + }, "MaxResults": { "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectivesMaxResults", "traits": { @@ -1715,6 +1743,12 @@ "smithy.api#httpQuery": "NextToken" } }, + "MetricSourceTypes": { + "target": "com.amazonaws.applicationsignals#MetricSourceTypes", + "traits": { + "smithy.api#documentation": "

Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

\n " + } + }, "IncludeLinkedAccounts": { "target": "smithy.api#Boolean", "traits": { @@ -2240,6 +2274,41 @@ "target": "com.amazonaws.applicationsignals#MetricReference" } }, + "com.amazonaws.applicationsignals#MetricSourceType": { + "type": "enum", + "members": { + "SERVICE_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceOperation" + } + }, + "CLOUDWATCH_METRIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudWatchMetric" + } + }, + "SERVICE_DEPENDENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceDependency" + } + } + } + }, + "com.amazonaws.applicationsignals#MetricSourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#MetricSourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, "com.amazonaws.applicationsignals#MetricStat": { "type": "structure", "members": { @@ -2434,6 +2503,12 @@ "smithy.api#documentation": "

This structure defines the metric that is used as the \"good request\" or \"bad request\"\n value for a request-based SLO. \n This value observed for the metric defined in \n TotalRequestCountMetric is divided by the number found for \n MonitoredRequestCountMetric to determine the percentage of successful requests that \n this SLO tracks.

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

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\"\n value for a request-based SLO. \n This value observed for the metric defined in \n TotalRequestCountMetric will be divided by the number found for \n MonitoredRequestCountMetric to determine the percentage of successful requests that \n this SLO tracks.

" } + }, + "DependencyConfig": { + "target": "com.amazonaws.applicationsignals#DependencyConfig", + "traits": { + "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n this structure includes the information about that metric or expression.

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

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n use this structure to specify that metric or expression.

" } + }, + "DependencyConfig": { + "target": "com.amazonaws.applicationsignals#DependencyConfig", + "traits": { + "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

Each object in this array defines the length of the look-back window used to calculate one burn rate metric\n for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" } + }, + "MetricSourceType": { + "target": "com.amazonaws.applicationsignals#MetricSourceType", + "traits": { + "smithy.api#documentation": "

Displays the SLI metric source type for this SLO. Supported types are:

\n " + } } }, "traits": { @@ -3230,11 +3329,29 @@ "smithy.api#documentation": "

If this service level objective is specific to a single operation, this \n field displays the name of that operation.

" } }, + "DependencyConfig": { + "target": "com.amazonaws.applicationsignals#DependencyConfig", + "traits": { + "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" } + }, + "EvaluationType": { + "target": "com.amazonaws.applicationsignals#EvaluationType", + "traits": { + "smithy.api#documentation": "

Displays whether this is a period-based SLO or a request-based SLO.

" + } + }, + "MetricSourceType": { + "target": "com.amazonaws.applicationsignals#MetricSourceType", + "traits": { + "smithy.api#documentation": "

Displays the SLI metric source type for this SLO. Supported types are:

\n " + } } }, "traits": { diff --git a/apprunner/service/2020-05-15/apprunner-2020-05-15.json b/apprunner/service/2020-05-15/apprunner-2020-05-15.json index da0f33ed..1f5fd271 100644 --- a/apprunner/service/2020-05-15/apprunner-2020-05-15.json +++ b/apprunner/service/2020-05-15/apprunner-2020-05-15.json @@ -4514,6 +4514,12 @@ "traits": { "smithy.api#enumValue": "NODEJS_18" } + }, + "NODEJS_22": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODEJS_22" + } } } }, diff --git a/appsync/service/2017-07-25/appsync-2017-07-25.json b/appsync/service/2017-07-25/appsync-2017-07-25.json index 722fcfcc..840a5d12 100644 --- a/appsync/service/2017-07-25/appsync-2017-07-25.json +++ b/appsync/service/2017-07-25/appsync-2017-07-25.json @@ -2206,6 +2206,12 @@ "traits": { "smithy.api#documentation": "

The date and time that the ChannelNamespace was last changed.

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

The configuration for the OnPublish and OnSubscribe handlers.

" + } } }, "traits": { @@ -2791,6 +2797,12 @@ }, "tags": { "target": "com.amazonaws.appsync#TagMap" + }, + "handlerConfigs": { + "target": "com.amazonaws.appsync#HandlerConfigs", + "traits": { + "smithy.api#documentation": "

The configuration for the OnPublish and OnSubscribe handlers.

" + } } }, "traits": { @@ -6796,6 +6808,65 @@ "target": "com.amazonaws.appsync#GraphqlApi" } }, + "com.amazonaws.appsync#HandlerBehavior": { + "type": "enum", + "members": { + "CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE" + } + }, + "DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT" + } + } + } + }, + "com.amazonaws.appsync#HandlerConfig": { + "type": "structure", + "members": { + "behavior": { + "target": "com.amazonaws.appsync#HandlerBehavior", + "traits": { + "smithy.api#documentation": "

The behavior for the handler.

", + "smithy.api#required": {} + } + }, + "integration": { + "target": "com.amazonaws.appsync#Integration", + "traits": { + "smithy.api#documentation": "

The integration data source configuration for the handler.

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

The configuration for a handler.

" + } + }, + "com.amazonaws.appsync#HandlerConfigs": { + "type": "structure", + "members": { + "onPublish": { + "target": "com.amazonaws.appsync#HandlerConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the OnPublish handler.

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

The configuration for the OnSubscribe handler.

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

The configuration for the OnPublish and OnSubscribe handlers.

" + } + }, "com.amazonaws.appsync#HttpDataSourceConfig": { "type": "structure", "members": { @@ -6816,6 +6887,27 @@ "smithy.api#documentation": "

Describes an HTTP data source configuration.

" } }, + "com.amazonaws.appsync#Integration": { + "type": "structure", + "members": { + "dataSourceName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The unique name of the data source that has been configured on the API.

", + "smithy.api#required": {} + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaConfig", + "traits": { + "smithy.api#documentation": "

The configuration for a Lambda data source.

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

The integration data source configuration for the handler.

" + } + }, "com.amazonaws.appsync#InternalFailureException": { "type": "structure", "members": { @@ -6829,6 +6921,23 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.appsync#InvokeType": { + "type": "enum", + "members": { + "REQUEST_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST_RESPONSE" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } + } + }, "com.amazonaws.appsync#LambdaAuthorizerConfig": { "type": "structure", "members": { @@ -6857,6 +6966,20 @@ "smithy.api#documentation": "

A LambdaAuthorizerConfig specifies how to authorize AppSync\n API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a\n time.

" } }, + "com.amazonaws.appsync#LambdaConfig": { + "type": "structure", + "members": { + "invokeType": { + "target": "com.amazonaws.appsync#InvokeType", + "traits": { + "smithy.api#documentation": "

The invocation type for a Lambda data source.

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

The configuration for a Lambda data source.

" + } + }, "com.amazonaws.appsync#LambdaConflictHandlerConfig": { "type": "structure", "members": { @@ -9839,6 +9962,12 @@ "traits": { "smithy.api#documentation": "

The event handler functions that run custom business logic to process published events\n and subscribe requests.

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

The configuration for the OnPublish and OnSubscribe handlers.

" + } } }, "traits": { diff --git a/arc-zonal-shift/service/2022-10-30/arc-zonal-shift-2022-10-30.json b/arc-zonal-shift/service/2022-10-30/arc-zonal-shift-2022-10-30.json index daf5633d..0008d782 100644 --- a/arc-zonal-shift/service/2022-10-30/arc-zonal-shift-2022-10-30.json +++ b/arc-zonal-shift/service/2022-10-30/arc-zonal-shift-2022-10-30.json @@ -177,7 +177,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource \n\t\t\taway from an Availability Zone in an Amazon Web Services Region\n\t\t\twhen Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.\n\t\t\tYou can configure zonal autoshift in ARC for managed resources in your Amazon Web Services account in a Region. \n\t\t\tSupported Amazon Web Services resources are automatically registered with ARC.

\n

Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and \n\t\t\ttraffic for the resource is no longer directed to the other Availability Zones in the Region.

\n

You can stop an autoshift for a resource by disabling zonal autoshift.

" + "smithy.api#documentation": "

Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource \n\t\t\taway from an Availability Zone in an Amazon Web Services Region\n\t\t\twhen Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.\n\t\t\tYou can configure zonal autoshift in ARC for managed resources in your Amazon Web Services account in a Region. \n\t\t\tSupported Amazon Web Services resources are automatically registered with ARC.

\n

Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and \n\t\t\ttraffic for the resource is no longer directed to the other Availability Zones in the Region.

" } }, "com.amazonaws.arczonalshift#AutoshiftTriggerResource": { @@ -1013,7 +1013,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.\n \t\tListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on \n \t\tyour behalf for zonal autoshift.

\n

For more information about listing\n \t\tautoshifts, see \">ListAutoshifts.

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

Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.

", "smithy.api#http": { "method": "GET", "uri": "/zonalshifts", @@ -2594,6 +2594,12 @@ "traits": { "smithy.api#enumValue": "FISExperimentUpdateNotAllowed" } + }, + "AUTOSHIFT_UPDATE_NOT_ALLOWED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoshiftUpdateNotAllowed" + } } } }, diff --git a/auto-scaling/service/2011-01-01/auto-scaling-2011-01-01.json b/auto-scaling/service/2011-01-01/auto-scaling-2011-01-01.json index d06ffed2..c10b0185 100644 --- a/auto-scaling/service/2011-01-01/auto-scaling-2011-01-01.json +++ b/auto-scaling/service/2011-01-01/auto-scaling-2011-01-01.json @@ -866,7 +866,7 @@ "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.

" + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, \n see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.\n

" } }, "ServiceLinkedRoleARN": { @@ -11224,7 +11224,7 @@ "CapacityRebalance": { "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "

Enables or disables Capacity Rebalancing. For more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Enables or disables Capacity Rebalancing. If Capacity Rebalancing is disabled, proactive replacement of at-risk Spot Instances does not occur. For more information, see Capacity\n Rebalancing in Auto Scaling to replace at-risk Spot Instances in the Amazon EC2 Auto Scaling User Guide.

\n \n

To suspend rebalancing across Availability Zones, use the SuspendProcesses API.

\n " } }, "Context": { diff --git a/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json b/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json index f54ca4f8..0f351b5b 100644 --- a/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json +++ b/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json @@ -12535,6 +12535,12 @@ "traits": { "smithy.api#documentation": "

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

" } + }, + "textIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "

The name of the text search index in the MongoDB collection. This is required for using the hybrid search\n feature.

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

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", "smithy.api#required": {} } + }, + "customMetadataField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "

Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from \n your data source.

" + } } }, "traits": { diff --git a/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json b/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json index 0e1b0da6..c168589b 100644 --- a/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json +++ b/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json @@ -767,6 +767,17 @@ "smithy.api#documentation": "List of Audio Extraction Category Type" } }, + "com.amazonaws.bedrockdataautomation#AudioOverrideConfiguration": { + "type": "structure", + "members": { + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Audio" + } + }, "com.amazonaws.bedrockdataautomation#AudioStandardExtraction": { "type": "structure", "members": { @@ -1798,6 +1809,38 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockdataautomation#DesiredModality": { + "type": "enum", + "members": { + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "AUDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + } + }, + "traits": { + "smithy.api#documentation": "Desired Modality types" + } + }, "com.amazonaws.bedrockdataautomation#DocumentBoundingBox": { "type": "structure", "members": { @@ -1955,6 +1998,9 @@ "members": { "splitter": { "target": "com.amazonaws.bedrockdataautomation#SplitterConfiguration" + }, + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" } }, "traits": { @@ -2268,6 +2314,17 @@ "smithy.api#documentation": "List of Image Extraction Category" } }, + "com.amazonaws.bedrockdataautomation#ImageOverrideConfiguration": { + "type": "structure", + "members": { + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Image" + } + }, "com.amazonaws.bedrockdataautomation#ImageStandardExtraction": { "type": "structure", "members": { @@ -2622,6 +2679,37 @@ } } }, + "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State" + } + }, + "traits": { + "smithy.api#documentation": "Configuration to enable/disable processing of modality" + } + }, + "com.amazonaws.bedrockdataautomation#ModalityRoutingConfiguration": { + "type": "structure", + "members": { + "jpeg": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "png": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "mp4": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + }, + "mov": { + "target": "com.amazonaws.bedrockdataautomation#DesiredModality" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for routing file type to desired modality" + } + }, "com.amazonaws.bedrockdataautomation#NextToken": { "type": "string", "traits": { @@ -2645,6 +2733,18 @@ "members": { "document": { "target": "com.amazonaws.bedrockdataautomation#DocumentOverrideConfiguration" + }, + "image": { + "target": "com.amazonaws.bedrockdataautomation#ImageOverrideConfiguration" + }, + "video": { + "target": "com.amazonaws.bedrockdataautomation#VideoOverrideConfiguration" + }, + "audio": { + "target": "com.amazonaws.bedrockdataautomation#AudioOverrideConfiguration" + }, + "modalityRouting": { + "target": "com.amazonaws.bedrockdataautomation#ModalityRoutingConfiguration" } }, "traits": { @@ -3279,6 +3379,17 @@ "smithy.api#documentation": "List of Video Extraction Category Type" } }, + "com.amazonaws.bedrockdataautomation#VideoOverrideConfiguration": { + "type": "structure", + "members": { + "modalityProcessing": { + "target": "com.amazonaws.bedrockdataautomation#ModalityProcessingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Override Configuration of Video" + } + }, "com.amazonaws.bedrockdataautomation#VideoStandardExtraction": { "type": "structure", "members": { diff --git a/bedrock-runtime/service/2023-09-30/bedrock-runtime-2023-09-30.json b/bedrock-runtime/service/2023-09-30/bedrock-runtime-2023-09-30.json index 05269c23..4523f351 100644 --- a/bedrock-runtime/service/2023-09-30/bedrock-runtime-2023-09-30.json +++ b/bedrock-runtime/service/2023-09-30/bedrock-runtime-2023-09-30.json @@ -805,6 +805,12 @@ "smithy.api#documentation": "

The content details used in the request to apply the guardrail.

", "smithy.api#required": {} } + }, + "outputScope": { + "target": "com.amazonaws.bedrockruntime#GuardrailOutputScope", + "traits": { + "smithy.api#documentation": "

Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

\n

Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

" + } } }, "traits": { @@ -828,6 +834,12 @@ "smithy.api#required": {} } }, + "actionReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason for the action taken when harmful content is detected.

" + } + }, "outputs": { "target": "com.amazonaws.bedrockruntime#GuardrailOutputContentList", "traits": { @@ -1049,6 +1061,36 @@ "smithy.api#documentation": "

The Model automatically decides if a tool should be called or whether to generate text instead.\n For example, {\"auto\" : {}}.

" } }, + "com.amazonaws.bedrockruntime#BidirectionalInputPayloadPart": { + "type": "structure", + "members": { + "bytes": { + "target": "com.amazonaws.bedrockruntime#PartBody", + "traits": { + "smithy.api#documentation": "

The audio content for the bidirectional input.

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

Payload content for the bidirectional input. The input is an audio stream.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockruntime#BidirectionalOutputPayloadPart": { + "type": "structure", + "members": { + "bytes": { + "target": "com.amazonaws.bedrockruntime#PartBody", + "traits": { + "smithy.api#documentation": "

The speech output of the bidirectional stream.

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

Output from the bidirectional stream. The output is speech and a text transcription.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockruntime#Body": { "type": "blob", "traits": { @@ -1058,6 +1100,32 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockruntime#CachePointBlock": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockruntime#CachePointType", + "traits": { + "smithy.api#documentation": "

Specifies the type of cache point within the CachePointBlock.

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

Defines a section of content to be cached for reuse in subsequent API calls.

" + } + }, + "com.amazonaws.bedrockruntime#CachePointType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, "com.amazonaws.bedrockruntime#ConflictException": { "type": "structure", "members": { @@ -1116,6 +1184,12 @@ "smithy.api#documentation": "

Contains the content to assess with the guardrail. If you don't specify\n guardContent in a call to the Converse API, the guardrail (if passed in the\n Converse API) assesses the entire message.

\n

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.\n\n

" } }, + "cachePoint": { + "target": "com.amazonaws.bedrockruntime#CachePointBlock", + "traits": { + "smithy.api#documentation": "

CachePoint to include in the message.

" + } + }, "reasoningContent": { "target": "com.amazonaws.bedrockruntime#ReasoningContentBlock", "traits": { @@ -1874,6 +1948,12 @@ "min": 1 } } + }, + "s3Location": { + "target": "com.amazonaws.bedrockruntime#S3Location", + "traits": { + "smithy.api#documentation": "

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

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

The guardrail action.

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

Indicates whether content that breaches the guardrail configuration is detected.

" + } } }, "traits": { @@ -2283,6 +2369,12 @@ "traits": { "smithy.api#enumValue": "BLOCKED" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } } } }, @@ -2391,6 +2483,12 @@ "smithy.api#documentation": "

The action performed by the guardrails contextual grounding filter.

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

Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

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

The action for the custom word.

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

Indicates whether custom word content that breaches the guardrail configuration is detected.

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

The action for the managed word.

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

Indicates whether managed word content that breaches the guardrail configuration is detected.

" + } } }, "traits": { @@ -2809,6 +2919,23 @@ "target": "com.amazonaws.bedrockruntime#GuardrailOutputContent" } }, + "com.amazonaws.bedrockruntime#GuardrailOutputScope": { + "type": "enum", + "members": { + "INTERVENTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERVENTIONS" + } + }, + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL" + } + } + } + }, "com.amazonaws.bedrockruntime#GuardrailOutputText": { "type": "string" }, @@ -2835,6 +2962,12 @@ "smithy.api#documentation": "

The PII entity filter action.

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

Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.

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

The region filter action.

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

Indicates whether custom regex entities that breach the guardrail configuration are detected.

" + } } }, "traits": { @@ -3102,6 +3241,12 @@ "traits": { "smithy.api#enumValue": "BLOCKED" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } } } }, @@ -3250,6 +3395,12 @@ "smithy.api#documentation": "

The action the guardrail should take when it intervenes on a topic.

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

Indicates whether topic content that breaches the guardrail configuration is detected.

" + } } }, "traits": { @@ -3270,6 +3421,12 @@ "traits": { "smithy.api#enumValue": "BLOCKED" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } } } }, @@ -3316,6 +3473,12 @@ "traits": { "smithy.api#enumValue": "disabled" } + }, + "ENABLED_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled_full" + } } } }, @@ -3339,6 +3502,12 @@ "traits": { "smithy.api#documentation": "

the output assessments.

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

Provides the reason for the action taken when harmful content is detected.

" + } } }, "traits": { @@ -3415,6 +3584,12 @@ "traits": { "smithy.api#enumValue": "BLOCKED" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } } } }, @@ -3505,6 +3680,12 @@ "min": 1 } } + }, + "s3Location": { + "target": "com.amazonaws.bedrockruntime#S3Location", + "traits": { + "smithy.api#documentation": "

The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

" + } } }, "traits": { @@ -3575,6 +3756,9 @@ { "target": "com.amazonaws.bedrockruntime#InvokeModel" }, + { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStream" + }, { "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream" } @@ -3759,6 +3943,164 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Invoke the specified Amazon Bedrock model to run inference using the bidirectional stream. The response is returned in a stream that remains open for 8 minutes. A single session can contain multiple prompts and responses from the model. The prompts to the model are provided as audio files and the model's responses are spoken back to the user and transcribed.

\n

It is possible for users to interrupt the model's response with a new prompt, which will halt the response speech. The model will retain contextual awareness of the conversation while pivoting to respond to the new prompt.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model/{modelId}/invoke-with-bidirectional-stream" + } + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamInput": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockruntime#BidirectionalInputPayloadPart", + "traits": { + "smithy.api#documentation": "

The audio chunk that is used as input for the invocation step.

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

Payload content, the speech chunk, for the bidirectional input of the invocation step.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamOutput": { + "type": "union", + "members": { + "chunk": { + "target": "com.amazonaws.bedrockruntime#BidirectionalOutputPayloadPart", + "traits": { + "smithy.api#documentation": "

The speech chunk that was provided as output from the invocation step.

" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

The request encountered an unknown internal error.

" + } + }, + "modelStreamErrorException": { + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + "traits": { + "smithy.api#documentation": "

The request encountered an error with the model stream.

" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockruntime#ValidationException", + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

" + } + }, + "modelTimeoutException": { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException", + "traits": { + "smithy.api#documentation": "

The connection was closed because a request was not received within the timeout period.

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

The request has failed due to a temporary failure of the server.

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

Output from the bidirectional stream that was used for model invocation.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", + "traits": { + "smithy.api#documentation": "

The model ID or ARN of the model ID to use. Currently, only amazon.nova-sonic-v1:0 is supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "body": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamInput", + "traits": { + "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the BidirectionalInputPayloadPart in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamResponse": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStreamOutput", + "traits": { + "smithy.api#documentation": "

Streaming response from the model in the format specified by the BidirectionalOutputPayloadPart header.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream": { "type": "operation", "input": { @@ -4522,7 +4864,7 @@ } }, "traits": { - "smithy.api#documentation": "

A storage location in an S3 bucket.

" + "smithy.api#documentation": "

A storage location in an Amazon S3 bucket.

" } }, "com.amazonaws.bedrockruntime#S3Uri": { @@ -4769,6 +5111,12 @@ "traits": { "smithy.api#documentation": "

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

\n

For more information, see Use a guardrail with the Converse\n API in the Amazon Bedrock User Guide.

" } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockruntime#CachePointBlock", + "traits": { + "smithy.api#documentation": "

CachePoint to include in the system prompt.

" + } } }, "traits": { @@ -4892,6 +5240,24 @@ }, "smithy.api#required": {} } + }, + "cacheReadInputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of input tokens read from the cache for the request.

", + "smithy.api#range": { + "min": 0 + } + } + }, + "cacheWriteInputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of input tokens written to the cache for the request.

", + "smithy.api#range": { + "min": 0 + } + } } }, "traits": { @@ -4906,6 +5272,12 @@ "traits": { "smithy.api#documentation": "

The specfication for the tool.

" } + }, + "cachePoint": { + "target": "com.amazonaws.bedrockruntime#CachePointBlock", + "traits": { + "smithy.api#documentation": "

CachePoint to include in the tool configuration.

" + } } }, "traits": { @@ -5199,6 +5571,12 @@ "traits": { "smithy.api#enumValue": "DISABLED" } + }, + "ENABLED_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_FULL" + } } } }, @@ -5311,7 +5689,7 @@ "s3Location": { "target": "com.amazonaws.bedrockruntime#S3Location", "traits": { - "smithy.api#documentation": "

The location of a video object in an S3 bucket.

" + "smithy.api#documentation": "

The location of a video object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

" } } }, diff --git a/bedrock/service/2023-04-20/bedrock-2023-04-20.json b/bedrock/service/2023-04-20/bedrock-2023-04-20.json index ce05227b..77c3cfbf 100644 --- a/bedrock/service/2023-04-20/bedrock-2023-04-20.json +++ b/bedrock/service/2023-04-20/bedrock-2023-04-20.json @@ -811,12 +811,66 @@ "traits": { "smithy.api#documentation": "

Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" } + }, + "customMetricConfig": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricConfig", + "traits": { + "smithy.api#documentation": "

Defines the configuration of custom metrics to be used in an evaluation job.

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

The configuration details of an automated evaluation job. The EvaluationDatasetMetricConfig object \n is used to specify the prompt datasets, task type, and metric names.

" } }, + "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricConfig": { + "type": "structure", + "members": { + "customMetrics": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationCustomMetrics", + "traits": { + "smithy.api#documentation": "

Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.

", + "smithy.api#required": {} + } + }, + "evaluatorModelConfig": { + "target": "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

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

Defines the configuration of custom metrics to be used in an evaluation job. To learn more about using custom metrics \n in Amazon Bedrock evaluation jobs, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and \n Create a prompt for a custom metrics (RAG evaluations).

" + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricSource": { + "type": "union", + "members": { + "customMetricDefinition": { + "target": "com.amazonaws.bedrock#CustomMetricDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a custom metric for use in an Amazon Bedrock evaluation job.

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

An array item definining a single custom metric for use in an Amazon Bedrock evaluation job.

" + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationCustomMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationCustomMetricSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.bedrock#BaseModelIdentifier": { "type": "string", "traits": { @@ -857,6 +911,33 @@ ], "traits": { "smithy.api#documentation": "

Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has \n following status FAILED, COMPLETED, and STOPPED. \n You can request up to 25 model evaluation jobs be deleted in a single request.

", + "smithy.api#examples": [ + { + "title": "Delete evaluation jobs", + "documentation": "The following example shows a request to delete two model evaluation jobs, where one of the jobs is not found.", + "input": { + "jobIdentifiers": [ + "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", + "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" + ] + }, + "output": { + "evaluationJobs": [ + { + "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", + "jobStatus": "Deleting" + } + ], + "errors": [ + { + "message": "Unable to locate this job to delete.", + "code": "404", + "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" + } + ] + } + } + ], "smithy.api#http": { "code": 202, "method": "POST", @@ -1029,7 +1110,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))))|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, "com.amazonaws.bedrock#BedrockModelId": { @@ -2475,6 +2556,86 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluator model for custom metrics. For a list of supported evaluator models, see Evaluate model performance \n using another LLM as a judge and Evaluate the performance of RAG sources using Amazon Bedrock evaluations.

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

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

" + } + }, + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#CustomMetricDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#MetricName", + "traits": { + "smithy.api#documentation": "

The name for a custom metric. Names must be unique in your Amazon Web Services region.

", + "smithy.api#required": {} + } + }, + "instructions": { + "target": "com.amazonaws.bedrock#CustomMetricInstructions", + "traits": { + "smithy.api#documentation": "

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

", + "smithy.api#required": {} + } + }, + "ratingScale": { + "target": "com.amazonaws.bedrock#RatingScale", + "traits": { + "smithy.api#documentation": "

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't \n define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For \n more information on specifying a rating scale, see Specifying an output schema (rating scale).

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

The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, \n a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.

\n

For more information about how to define a custom metric in Amazon Bedrock, \n see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and \n Create a prompt for a custom metrics (RAG evaluations).

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig": { + "type": "structure", + "members": { + "bedrockEvaluatorModels": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels", + "traits": { + "smithy.api#documentation": "

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

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

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

" + } + }, + "com.amazonaws.bedrock#CustomMetricInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, "com.amazonaws.bedrock#CustomModelArn": { "type": "string", "traits": { @@ -3255,7 +3416,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}$" } }, "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers": { @@ -3345,7 +3506,7 @@ "metricNames": { "target": "com.amazonaws.bedrock#EvaluationMetricNames", "traits": { - "smithy.api#documentation": "

The names of the metrics you want to use for your evaluation job.

\n

For knowledge base evaluation jobs that evaluate retrieval only, valid values are \n \"Builtin.ContextRelevance\", \"Builtin.ContextConverage\".

\n

For knowledge base evaluation jobs that evaluate retrieval with response generation, \n valid values are \"Builtin.Correctness\", \"Builtin.Completeness\", \n \"Builtin.Helpfulness\", \"Builtin.LogicalCoherence\", \n \"Builtin.Faithfulness\", \"Builtin.Harmfulness\", \n \"Builtin.Stereotyping\", \"Builtin.Refusal\".

\n

For automated model evaluation jobs, valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In model evaluation jobs that use a LLM as judge you can specify \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Faithfulness\", \"Builtin.Helpfulness\", \"Builtin.Coherence\", \"Builtin.Relevance\", \"Builtin.FollowingInstructions\", \"Builtin.ProfessionalStyleAndTone\", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", and \"Builtin.Refusal\".

\n

For human-based model evaluation jobs, the list of strings must match the \n name parameter specified in HumanEvaluationCustomMetric.

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

The names of the metrics you want to use for your evaluation job.

\n

For knowledge base evaluation jobs that evaluate retrieval only, valid values are \n \"Builtin.ContextRelevance\", \"Builtin.ContextCoverage\".

\n

For knowledge base evaluation jobs that evaluate retrieval with response generation, \n valid values are \"Builtin.Correctness\", \"Builtin.Completeness\", \n \"Builtin.Helpfulness\", \"Builtin.LogicalCoherence\", \n \"Builtin.Faithfulness\", \"Builtin.Harmfulness\", \n \"Builtin.Stereotyping\", \"Builtin.Refusal\".

\n

For automated model evaluation jobs, valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In model evaluation jobs that use a LLM as judge you can specify \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Faithfulness\", \"Builtin.Helpfulness\", \"Builtin.Coherence\", \"Builtin.Relevance\", \"Builtin.FollowingInstructions\", \"Builtin.ProfessionalStyleAndTone\", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", and \"Builtin.Refusal\".

\n

For human-based model evaluation jobs, the list of strings must match the \n name parameter specified in HumanEvaluationCustomMetric.

", "smithy.api#required": {} } } @@ -3577,7 +3738,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 15 + "max": 25 } } }, @@ -3882,6 +4043,12 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

" } }, + "customMetricsEvaluatorModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

" + } + }, "inferenceConfigSummary": { "target": "com.amazonaws.bedrock#EvaluationInferenceConfigSummary", "traits": { @@ -5807,7 +5974,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

\n

The following statuses are possible:

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

The status of the batch inference job.

\n

The following statuses are possible:

\n " } }, "message": { @@ -6280,12 +6447,56 @@ "traits": { "smithy.api#documentation": "

The output modalities selected for the guardrail content filter.

" } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " } }, + "com.amazonaws.bedrock#GuardrailContentFilterAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#GuardrailContentFilterConfig": { "type": "structure", "members": { @@ -6321,6 +6532,30 @@ "traits": { "smithy.api#documentation": "

The output modalities selected for the guardrail content filter configuration.

" } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6421,6 +6656,26 @@ "smithy.api#documentation": "

Contains details about how to handle harmful content.

" } }, + "com.amazonaws.bedrock#GuardrailContextualGroundingAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#GuardrailContextualGroundingFilter": { "type": "structure", "members": { @@ -6440,6 +6695,18 @@ }, "smithy.api#required": {} } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingAction", + "traits": { + "smithy.api#documentation": "

The action to take when content fails the contextual grounding evaluation. Supported values include:

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

Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6465,6 +6732,18 @@ }, "smithy.api#required": {} } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:

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

Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6649,6 +6928,30 @@ "smithy.api#documentation": "

ManagedWords$type\n The managed word type that was configured for the guardrail.\n (For now, we only offer profanity word list)

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6664,6 +6967,30 @@ "smithy.api#documentation": "

The managed word type to configure for the guardrail.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the input. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6770,6 +7097,30 @@ "smithy.api#documentation": "

The configured guardrail action when PII entity is detected.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -6792,6 +7143,30 @@ "smithy.api#documentation": "

Configure guardrail action when the PII entity is detected.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -7030,6 +7405,30 @@ "smithy.api#documentation": "

The action taken when a match to the regular expression is detected.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -7077,6 +7476,30 @@ "smithy.api#documentation": "

The guardrail action to configure when matching regular expression is detected.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -7115,6 +7538,12 @@ "traits": { "smithy.api#enumValue": "ANONYMIZE" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } } } }, @@ -7322,12 +7751,56 @@ "traits": { "smithy.api#documentation": "

Specifies to deny the topic.

" } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " } }, + "com.amazonaws.bedrock#GuardrailTopicAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#GuardrailTopicConfig": { "type": "structure", "members": { @@ -7357,6 +7830,30 @@ "smithy.api#documentation": "

Specifies to deny the topic.

", "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailTopicAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -7490,12 +7987,56 @@ }, "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

The action to take when harmful content is detected in the output. Supported values include:

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

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't\n charged for the evaluation. The evaluation doesn't appear in the response.

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

Indicates whether guardrail evaluation is enabled on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

A word configured for the guardrail.

" } }, + "com.amazonaws.bedrock#GuardrailWordAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#GuardrailWordConfig": { "type": "structure", "members": { @@ -7509,6 +8050,30 @@ }, "smithy.api#required": {} } + }, + "inputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the input. Supported values include:

\n " + } + }, + "outputAction": { + "target": "com.amazonaws.bedrock#GuardrailWordAction", + "traits": { + "smithy.api#documentation": "

Specifies the action to take when harmful content is detected in the output. Supported values include:

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

Specifies whether to enable guardrail evaluation on the intput. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

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

Specifies whether to enable guardrail evaluation on the output. When disabled, you\n aren't charged for the evaluation. The evaluation doesn't appear in the response.

" + } } }, "traits": { @@ -9471,7 +10036,7 @@ "statusEquals": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

\n

The following statuses are possible:

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

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

\n

The following statuses are possible:

\n ", "smithy.api#httpQuery": "statusEquals" } }, @@ -10039,6 +10604,17 @@ "com.amazonaws.bedrock#MetricFloat": { "type": "float" }, + "com.amazonaws.bedrock#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#ModelArchitecture": { "type": "string" }, @@ -10049,7 +10625,7 @@ "min": 20, "max": 1011 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" } }, "com.amazonaws.bedrock#ModelCopyJobArn": { @@ -10766,7 +11342,7 @@ "status": { "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

\n

The following statuses are possible:

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

The status of the batch inference job.

\n

The following statuses are possible:

\n " } }, "message": { @@ -11502,6 +12078,73 @@ } } }, + "com.amazonaws.bedrock#RatingScale": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RatingScaleItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#RatingScaleItem": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.bedrock#RatingScaleItemDefinition", + "traits": { + "smithy.api#documentation": "

Defines the definition for one rating in a custom metric rating scale.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#RatingScaleItemValue", + "traits": { + "smithy.api#documentation": "

Defines the value for one rating in a custom metric rating scale.

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

Defines the value and corresponding definition for one rating in a custom metric rating scale.

" + } + }, + "com.amazonaws.bedrock#RatingScaleItemDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#RatingScaleItemValue": { + "type": "union", + "members": { + "stringValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A string representing the value for a rating in a custom metric rating scale.

", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "floatValue": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

A floating point number representing the value for a rating in a custom metric rating scale.

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

Defines the value for one rating in a custom metric rating scale.

" + } + }, "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint": { "type": "operation", "input": { @@ -11946,7 +12589,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}(?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" + "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" } }, "com.amazonaws.bedrock#SageMakerEndpoint": { diff --git a/budgets/service/2016-10-20/budgets-2016-10-20.json b/budgets/service/2016-10-20/budgets-2016-10-20.json index 152e14ab..b836eebf 100644 --- a/budgets/service/2016-10-20/budgets-2016-10-20.json +++ b/budgets/service/2016-10-20/budgets-2016-10-20.json @@ -1649,12 +1649,20 @@ "CostFilters": { "target": "com.amazonaws.budgets#CostFilters", "traits": { + "smithy.api#deprecated": { + "since": "2025-04-18", + "message": "CostFilters lack support for newer dimensions and filtering options. Please consider using the new 'FilterExpression' field." + }, "smithy.api#documentation": "

The cost filters, such as Region, Service,\n\t\t\t\tLinkedAccount, Tag, or CostCategory, that are\n\t\t\tapplied to a budget.

\n

Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

\n " } }, "CostTypes": { "target": "com.amazonaws.budgets#CostTypes", "traits": { + "smithy.api#deprecated": { + "since": "2025-04-18", + "message": "CostTypes lack support for newer record type dimensions and filtering options. Please consider using the new 'Metrics' field." + }, "smithy.api#documentation": "

The types of costs that are included in this COST budget.

\n

\n USAGE, RI_UTILIZATION, RI_COVERAGE,\n\t\t\t\tSAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE\n\t\t\tbudgets do not have CostTypes.

" } }, @@ -1668,7 +1676,7 @@ "TimePeriod": { "target": "com.amazonaws.budgets#TimePeriod", "traits": { - "smithy.api#documentation": "

The period of time that's covered by a budget. You setthe start date and end date. The\n\t\t\tstart date must come before the end date. The end date must come before 06/15/87\n\t\t\t\t00:00 UTC.

\n

If you create your budget and don't specify a start date, Amazon Web Services defaults\n\t\t\tto the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For\n\t\t\texample, if you created your budget on January 24, 2018, chose DAILY, and\n\t\t\tdidn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00\n\t\t\t\tUTC. If you chose MONTHLY, Amazon Web Services set your start\n\t\t\tdate to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are\n\t\t\tthe same for the Billing and Cost Management console and the API.

\n

You can change either date with the UpdateBudget operation.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" + "smithy.api#documentation": "

The period of time that's covered by a budget. You set the start date and end date. The\n\t\t\tstart date must come before the end date. The end date must come before 06/15/87\n\t\t\t\t00:00 UTC.

\n

If you create your budget and don't specify a start date, Amazon Web Services defaults\n\t\t\tto the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For\n\t\t\texample, if you created your budget on January 24, 2018, chose DAILY, and\n\t\t\tdidn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00\n\t\t\t\tUTC. If you chose MONTHLY, Amazon Web Services set your start\n\t\t\tdate to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are\n\t\t\tthe same for the Billing and Cost Management console and the API.

\n

You can change either date with the UpdateBudget operation.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" } }, "CalculatedSpend": { @@ -1695,6 +1703,18 @@ "traits": { "smithy.api#documentation": "

The parameters that determine the budget amount for an auto-adjusting budget.

" } + }, + "FilterExpression": { + "target": "com.amazonaws.budgets#Expression", + "traits": { + "smithy.api#documentation": "

The filtering dimensions for the budget and their corresponding values.

" + } + }, + "Metrics": { + "target": "com.amazonaws.budgets#Metrics", + "traits": { + "smithy.api#documentation": "

The definition for how the budget data is aggregated.

" + } } }, "traits": { @@ -1905,6 +1925,35 @@ "smithy.api#documentation": "

The comparison operator of a notification. Currently, the service supports the\n\t\t\tfollowing operators:

\n

\n GREATER_THAN, LESS_THAN, EQUAL_TO\n

" } }, + "com.amazonaws.budgets#CostCategoryName": { + "type": "string" + }, + "com.amazonaws.budgets#CostCategoryValues": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.budgets#CostCategoryName", + "traits": { + "smithy.api#documentation": "

The unique name of the cost category.

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

The specific value of the cost category.

" + } + }, + "MatchOptions": { + "target": "com.amazonaws.budgets#MatchOptions", + "traits": { + "smithy.api#documentation": "

The match options that you can use to filter your results.

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

The cost category values used for filtering the costs.

" + } + }, "com.amazonaws.budgets#CostFilters": { "type": "map", "key": { @@ -2023,7 +2072,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a budget and, if included, notifications and subscribers.

\n \n

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 " + "smithy.api#documentation": "

Creates a budget and, if included, notifications and subscribers.

\n \n

Only one of BudgetLimit or PlannedBudgetLimits can be present in\n the syntax at one time. Use the syntax that matches your use case. The Request Syntax\n section shows the BudgetLimit syntax. For PlannedBudgetLimits,\n see the Examples section.

\n

Similarly, only one set of filter and metric selections can be present in the syntax\n at one time. Either FilterExpression and Metrics or\n CostFilters and CostTypes, not both or a different\n combination. We recommend using FilterExpression and Metrics\n as they provide more flexible and powerful filtering capabilities. The Request Syntax\n section shows the FilterExpression/Metrics syntax.

\n " } }, "com.amazonaws.budgets#CreateBudgetAction": { @@ -2716,7 +2765,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a budget.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Describes a budget.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For\n PlannedBudgetLimits, see the Examples section.

\n " } }, "com.amazonaws.budgets#DescribeBudgetAction": { @@ -3235,6 +3284,12 @@ "smithy.api#documentation": "

The name of the budget that you want a description of.

", "smithy.api#required": {} } + }, + "ShowFilterExpression": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the response includes the filter expression associated with the\n budget. By showing the filter expression, you can see detailed filtering logic applied to\n the budget, such as Amazon Web Services services or tags that are being tracked.

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

Lists the budgets that are associated with an account.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Lists the budgets that are associated with an account.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For\n PlannedBudgetLimits, see the Examples section.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3319,6 +3374,12 @@ "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.

" } + }, + "ShowFilterExpression": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the response includes the filter expression associated with the\n budgets. By showing the filter expression, you can see detailed filtering logic applied to\n the budgets, such as Amazon Web Services services or tags that are being tracked.

" + } } }, "traits": { @@ -3548,6 +3609,209 @@ "smithy.api#output": {} } }, + "com.amazonaws.budgets#Dimension": { + "type": "enum", + "members": { + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "INSTANCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE" + } + }, + "LINKED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT" + } + }, + "LINKED_ACCOUNT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT_NAME" + } + }, + "OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION" + } + }, + "PURCHASE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PURCHASE_TYPE" + } + }, + "REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + }, + "SERVICE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_CODE" + } + }, + "USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE" + } + }, + "USAGE_TYPE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE_GROUP" + } + }, + "RECORD_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECORD_TYPE" + } + }, + "OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATING_SYSTEM" + } + }, + "TENANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENANCY" + } + }, + "SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + }, + "SUBSCRIPTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_ID" + } + }, + "LEGAL_ENTITY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGAL_ENTITY_NAME" + } + }, + "INVOICING_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVOICING_ENTITY" + } + }, + "DEPLOYMENT_OPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_OPTION" + } + }, + "DATABASE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABASE_ENGINE" + } + }, + "CACHE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CACHE_ENGINE" + } + }, + "INSTANCE_TYPE_FAMILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE_FAMILY" + } + }, + "BILLING_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_ENTITY" + } + }, + "RESERVATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATION_ID" + } + }, + "RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ID" + } + }, + "RIGHTSIZING_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHTSIZING_TYPE" + } + }, + "SAVINGS_PLANS_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS_TYPE" + } + }, + "SAVINGS_PLAN_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLAN_ARN" + } + }, + "PAYMENT_OPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYMENT_OPTION" + } + }, + "RESERVATION_MODIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATION_MODIFIED" + } + }, + "TAG_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG_KEY" + } + }, + "COST_CATEGORY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_CATEGORY_NAME" + } + } + } + }, "com.amazonaws.budgets#DimensionValue": { "type": "string", "traits": { @@ -3754,6 +4018,84 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.budgets#Expression": { + "type": "structure", + "members": { + "Or": { + "target": "com.amazonaws.budgets#Expressions", + "traits": { + "smithy.api#documentation": "

Return results that match either Dimension object.

" + } + }, + "And": { + "target": "com.amazonaws.budgets#Expressions", + "traits": { + "smithy.api#documentation": "

Return results that match both Dimension objects.

" + } + }, + "Not": { + "target": "com.amazonaws.budgets#Expression", + "traits": { + "smithy.api#documentation": "

Return results that don't match a Dimension object.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.budgets#ExpressionDimensionValues", + "traits": { + "smithy.api#documentation": "

The specific Dimension to use for Expression.

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

The specific Tag to use for Expression.

" + } + }, + "CostCategories": { + "target": "com.amazonaws.budgets#CostCategoryValues", + "traits": { + "smithy.api#documentation": "

The filter that's based on CostCategoryValues.

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

Use Expression to filter in various Budgets APIs.

" + } + }, + "com.amazonaws.budgets#ExpressionDimensionValues": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.budgets#Dimension", + "traits": { + "smithy.api#documentation": "

The name of the dimension that you want to filter on.

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

The metadata values you can specify to filter upon, so that the results all match at least\n\t\t\tone of the specified values.

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

The match options that you can use to filter your results. You can specify only one of these\n\t\t\tvalues in the array.

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

Contains the specifications for the filters to use for your request.

" + } + }, + "com.amazonaws.budgets#Expressions": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Expression" + } + }, "com.amazonaws.budgets#GenericString": { "type": "string", "traits": { @@ -3966,6 +4308,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.budgets#MatchOption": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "ABSENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSENT" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } + }, + "CASE_SENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_SENSITIVE" + } + }, + "CASE_INSENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_INSENSITIVE" + } + } + } + }, + "com.amazonaws.budgets#MatchOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#MatchOption" + } + }, "com.amazonaws.budgets#MaxResults": { "type": "integer", "traits": { @@ -3994,6 +4395,71 @@ } } }, + "com.amazonaws.budgets#Metric": { + "type": "enum", + "members": { + "BLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BlendedCost" + } + }, + "UNBLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnblendedCost" + } + }, + "AMORTIZED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AmortizedCost" + } + }, + "NET_UNBLENDED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetUnblendedCost" + } + }, + "NET_AMORTIZED_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetAmortizedCost" + } + }, + "USAGE_QUANTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UsageQuantity" + } + }, + "NORMALIZED_USAGE_AMOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NormalizedUsageAmount" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hours" + } + } + } + }, + "com.amazonaws.budgets#Metrics": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Metric" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.budgets#NotFoundException": { "type": "structure", "members": { @@ -4456,6 +4922,16 @@ "smithy.api#documentation": "

The subscription type of the subscriber. It can be SMS or EMAIL.

" } }, + "com.amazonaws.budgets#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, "com.amazonaws.budgets#TagResource": { "type": "operation", "input": { @@ -4517,6 +4993,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.budgets#TagValues": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.budgets#TagKey", + "traits": { + "smithy.api#documentation": "

The key for the tag.

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

The specific value of the tag.

" + } + }, + "MatchOptions": { + "target": "com.amazonaws.budgets#MatchOptions", + "traits": { + "smithy.api#documentation": "

The match options that you can use to filter your results.

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

The values that are available for a tag.

" + } + }, "com.amazonaws.budgets#TargetId": { "type": "string", "traits": { @@ -4719,7 +5221,7 @@ } ], "traits": { - "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 Amazon Web Services has new usage data to use for forecasting.

\n \n

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 " + "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 Amazon Web Services has new usage data to use for forecasting.

\n \n

Only one of BudgetLimit or PlannedBudgetLimits can be present in\n the syntax at one time. Use the syntax that matches your case. The Request Syntax\n section shows the BudgetLimit syntax. For PlannedBudgetLimits,\n see the Examples section.

\n

Similarly, only one set of filter and metric selections can be present in the syntax\n at one time. Either FilterExpression and Metrics or\n CostFilters and CostTypes, not both or a different\n combination. We recommend using FilterExpression and Metrics\n as they provide more flexible and powerful filtering capabilities. The Request Syntax\n section shows the FilterExpression/Metrics syntax.

\n " } }, "com.amazonaws.budgets#UpdateBudgetAction": { @@ -5053,6 +5555,27 @@ } } }, + "com.amazonaws.budgets#Value": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.budgets#Values": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Value" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.budgets#errorMessage": { "type": "string", "traits": { diff --git a/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json b/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json index 2a9d516a..88e078ab 100644 --- a/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json +++ b/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json @@ -7322,6 +7322,12 @@ "traits": { "smithy.api#documentation": "

The updated phone number order time stamp, in ISO 8601 format.

" } + }, + "FocDate": { + "target": "com.amazonaws.chimesdkvoice#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The Firm Order Commitment (FOC) date for phone number porting orders. This field is null\n if a phone number order is not a porting order.

" + } } }, "traits": { @@ -10939,6 +10945,9 @@ "target": "com.amazonaws.chimesdkvoice#ValidateE911AddressResponse" }, "errors": [ + { + "target": "com.amazonaws.chimesdkvoice#AccessDeniedException" + }, { "target": "com.amazonaws.chimesdkvoice#BadRequestException" }, diff --git a/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json b/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json index 7f897d07..61add062 100644 --- a/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json +++ b/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json @@ -15436,6 +15436,12 @@ "traits": { "smithy.api#documentation": "

A description of the collaboration.

" } + }, + "analyticsEngine": { + "target": "com.amazonaws.cleanrooms#AnalyticsEngine", + "traits": { + "smithy.api#documentation": "

The analytics engine.

" + } } } }, diff --git a/codebuild/service/2016-10-06/codebuild-2016-10-06.json b/codebuild/service/2016-10-06/codebuild-2016-10-06.json index d648ce66..8210ed6d 100644 --- a/codebuild/service/2016-10-06/codebuild-2016-10-06.json +++ b/codebuild/service/2016-10-06/codebuild-2016-10-06.json @@ -41,6 +41,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codebuild#AccountSuspendedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codebuild#String" + } + }, + "traits": { + "smithy.api#documentation": "

The CodeBuild access has been suspended for the calling Amazon Web Services account.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.codebuild#ArtifactNamespace": { "type": "enum", "members": { @@ -321,6 +333,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.codebuild#BatchGetCommandExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#BatchGetCommandExecutionsInput" + }, + "output": { + "target": "com.amazonaws.codebuild#BatchGetCommandExecutionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the command executions.

" + } + }, + "com.amazonaws.codebuild#BatchGetCommandExecutionsInput": { + "type": "structure", + "members": { + "sandboxId": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A sandboxId or sandboxArn.

", + "smithy.api#required": {} + } + }, + "commandExecutionIds": { + "target": "com.amazonaws.codebuild#CommandExecutionIds", + "traits": { + "smithy.api#documentation": "

A comma separated list of commandExecutionIds.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#BatchGetCommandExecutionsOutput": { + "type": "structure", + "members": { + "commandExecutions": { + "target": "com.amazonaws.codebuild#CommandExecutions", + "traits": { + "smithy.api#documentation": "

Information about the requested command executions.

" + } + }, + "commandExecutionsNotFound": { + "target": "com.amazonaws.codebuild#CommandExecutionIds", + "traits": { + "smithy.api#documentation": "

The IDs of command executions for which information could not be found.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codebuild#BatchGetFleets": { "type": "operation", "input": { @@ -529,6 +600,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.codebuild#BatchGetSandboxes": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#BatchGetSandboxesInput" + }, + "output": { + "target": "com.amazonaws.codebuild#BatchGetSandboxesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the sandbox status.

" + } + }, + "com.amazonaws.codebuild#BatchGetSandboxesInput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.codebuild#SandboxIds", + "traits": { + "smithy.api#documentation": "

A comma separated list of sandboxIds or sandboxArns.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#BatchGetSandboxesOutput": { + "type": "structure", + "members": { + "sandboxes": { + "target": "com.amazonaws.codebuild#Sandboxes", + "traits": { + "smithy.api#documentation": "

Information about the requested sandboxes.

" + } + }, + "sandboxesNotFound": { + "target": "com.amazonaws.codebuild#SandboxIds", + "traits": { + "smithy.api#documentation": "

The IDs of sandboxes for which information could not be found.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codebuild#BatchReportModeType": { "type": "enum", "members": { @@ -1557,6 +1680,9 @@ { "target": "com.amazonaws.codebuild#BatchGetBuilds" }, + { + "target": "com.amazonaws.codebuild#BatchGetCommandExecutions" + }, { "target": "com.amazonaws.codebuild#BatchGetFleets" }, @@ -1569,6 +1695,9 @@ { "target": "com.amazonaws.codebuild#BatchGetReports" }, + { + "target": "com.amazonaws.codebuild#BatchGetSandboxes" + }, { "target": "com.amazonaws.codebuild#CreateFleet" }, @@ -1635,6 +1764,9 @@ { "target": "com.amazonaws.codebuild#ListBuildsForProject" }, + { + "target": "com.amazonaws.codebuild#ListCommandExecutionsForSandbox" + }, { "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImages" }, @@ -1653,6 +1785,12 @@ { "target": "com.amazonaws.codebuild#ListReportsForReportGroup" }, + { + "target": "com.amazonaws.codebuild#ListSandboxes" + }, + { + "target": "com.amazonaws.codebuild#ListSandboxesForProject" + }, { "target": "com.amazonaws.codebuild#ListSharedProjects" }, @@ -1677,12 +1815,24 @@ { "target": "com.amazonaws.codebuild#StartBuildBatch" }, + { + "target": "com.amazonaws.codebuild#StartCommandExecution" + }, + { + "target": "com.amazonaws.codebuild#StartSandbox" + }, + { + "target": "com.amazonaws.codebuild#StartSandboxConnection" + }, { "target": "com.amazonaws.codebuild#StopBuild" }, { "target": "com.amazonaws.codebuild#StopBuildBatch" }, + { + "target": "com.amazonaws.codebuild#StopSandbox" + }, { "target": "com.amazonaws.codebuild#UpdateFleet" }, @@ -2812,6 +2962,118 @@ "target": "com.amazonaws.codebuild#CodeCoverage" } }, + "com.amazonaws.codebuild#CommandExecution": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the command execution.

" + } + }, + "sandboxId": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A sandboxId.

" + } + }, + "submitTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the command execution process was initially submitted, expressed in Unix time format.

" + } + }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the command execution process started, expressed in Unix time format.

" + } + }, + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the command execution process ended, expressed in Unix time format.

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

The status of the command execution.

" + } + }, + "command": { + "target": "com.amazonaws.codebuild#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "

The command that needs to be executed.

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

The command type.

" + } + }, + "exitCode": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The exit code to return upon completion.

" + } + }, + "standardOutputContent": { + "target": "com.amazonaws.codebuild#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "

The text written by the command to stdout.

" + } + }, + "standardErrContent": { + "target": "com.amazonaws.codebuild#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "

The text written by the command to stderr.

" + } + }, + "logs": { + "target": "com.amazonaws.codebuild#LogsLocation" + }, + "sandboxArn": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A sandboxArn.

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

Contains command execution information.

" + } + }, + "com.amazonaws.codebuild#CommandExecutionIds": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codebuild#CommandExecutions": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#CommandExecution" + } + }, + "com.amazonaws.codebuild#CommandType": { + "type": "enum", + "members": { + "SHELL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHELL" + } + } + } + }, "com.amazonaws.codebuild#ComputeConfiguration": { "type": "structure", "members": { @@ -2838,10 +3100,16 @@ "traits": { "smithy.api#documentation": "

The machine type of the instance type included in your fleet.

" } + }, + "instanceType": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The EC2 instance type to be launched in your fleet.

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

Contains compute attributes. These attributes only need be specified when your project's or fleet's computeType is set to ATTRIBUTE_BASED_COMPUTE.

" + "smithy.api#documentation": "

Contains compute attributes. These attributes only need be specified when your project's or fleet's computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.

" } }, "com.amazonaws.codebuild#ComputeType": { @@ -2912,6 +3180,12 @@ "traits": { "smithy.api#enumValue": "ATTRIBUTE_BASED_COMPUTE" } + }, + "CUSTOM_INSTANCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_INSTANCE_TYPE" + } } } }, @@ -4053,6 +4327,12 @@ "smithy.api#enumValue": "WINDOWS_SERVER_2019_CONTAINER" } }, + "WINDOWS_SERVER_2022_CONTAINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2022_CONTAINER" + } + }, "LINUX_LAMBDA_CONTAINER": { "target": "smithy.api#Unit", "traits": { @@ -4317,12 +4597,7 @@ } }, "com.amazonaws.codebuild#FleetCapacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } + "type": "integer" }, "com.amazonaws.codebuild#FleetContextCode": { "type": "enum", @@ -5326,68 +5601,147 @@ "smithy.api#output": {} } }, - "com.amazonaws.codebuild#ListCuratedEnvironmentImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput" - }, - "output": { - "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput" - }, - "traits": { - "smithy.api#documentation": "

Gets information about Docker images that are managed by CodeBuild.

" - } - }, - "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput": { - "type": "structure", - "members": { - "platforms": { - "target": "com.amazonaws.codebuild#EnvironmentPlatforms", - "traits": { - "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n CodeBuild.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.codebuild#ListFleets": { + "com.amazonaws.codebuild#ListCommandExecutionsForSandbox": { "type": "operation", "input": { - "target": "com.amazonaws.codebuild#ListFleetsInput" + "target": "com.amazonaws.codebuild#ListCommandExecutionsForSandboxInput" }, "output": { - "target": "com.amazonaws.codebuild#ListFleetsOutput" + "target": "com.amazonaws.codebuild#ListCommandExecutionsForSandboxOutput" }, "errors": [ { "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

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

Gets a list of command executions for a sandbox.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "commandExecutions", "pageSize": "maxResults" } } }, - "com.amazonaws.codebuild#ListFleetsInput": { + "com.amazonaws.codebuild#ListCommandExecutionsForSandboxInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codebuild#SensitiveString", + "sandboxId": { + "target": "com.amazonaws.codebuild#NonEmptyString", "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.

" + "smithy.api#documentation": "

A sandboxId or sandboxArn.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of sandbox records to be retrieved.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

The order in which sandbox records should be retrieved.

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

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#ListCommandExecutionsForSandboxOutput": { + "type": "structure", + "members": { + "commandExecutions": { + "target": "com.amazonaws.codebuild#CommandExecutions", + "traits": { + "smithy.api#documentation": "

Information about the requested command executions.

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

Information about the next token to get paginated results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codebuild#ListCuratedEnvironmentImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput" + }, + "output": { + "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets information about Docker images that are managed by CodeBuild.

" + } + }, + "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput": { + "type": "structure", + "members": { + "platforms": { + "target": "com.amazonaws.codebuild#EnvironmentPlatforms", + "traits": { + "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n CodeBuild.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codebuild#ListFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#ListFleetsInput" + }, + "output": { + "target": "com.amazonaws.codebuild#ListFleetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.codebuild#ListFleetsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codebuild#SensitiveString", + "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.

" } }, "maxResults": { @@ -5736,6 +6090,154 @@ "smithy.api#output": {} } }, + "com.amazonaws.codebuild#ListSandboxes": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#ListSandboxesInput" + }, + "output": { + "target": "com.amazonaws.codebuild#ListSandboxesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of sandboxes.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "ids", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.codebuild#ListSandboxesForProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#ListSandboxesForProjectInput" + }, + "output": { + "target": "com.amazonaws.codebuild#ListSandboxesForProjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of sandboxes for a given project.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "ids", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.codebuild#ListSandboxesForProjectInput": { + "type": "structure", + "members": { + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CodeBuild project name.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of sandbox records to be retrieved.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

The order in which sandbox records should be retrieved.

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

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#ListSandboxesForProjectOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.codebuild#SandboxIds", + "traits": { + "smithy.api#documentation": "

Information about the requested sandbox IDs.

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

Information about the next token to get paginated results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codebuild#ListSandboxesInput": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of sandbox records to be retrieved.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

The order in which sandbox records should be retrieved.

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

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#ListSandboxesOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.codebuild#SandboxIds", + "traits": { + "smithy.api#documentation": "

Information about the requested sandbox IDs.

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

Information about the next token to get paginated results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codebuild#ListSharedProjects": { "type": "operation", "input": { @@ -7692,57 +8194,317 @@ "smithy.api#documentation": "

Information about the S3 bucket where the raw data of a report are exported.

" } }, - "com.amazonaws.codebuild#ScalingConfigurationInput": { + "com.amazonaws.codebuild#SSMSession": { "type": "structure", "members": { - "scalingType": { - "target": "com.amazonaws.codebuild#FleetScalingType", + "sessionId": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The scaling type for a compute fleet.

" + "smithy.api#documentation": "

The ID of the session.

" } }, - "targetTrackingScalingConfigs": { - "target": "com.amazonaws.codebuild#TargetTrackingScalingConfigurations", + "tokenValue": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A list of TargetTrackingScalingConfiguration objects.

" + "smithy.api#documentation": "

An encrypted token value containing session and caller information.

" } }, - "maxCapacity": { - "target": "com.amazonaws.codebuild#FleetCapacity", + "streamUrl": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The maximum number of instances in the \ufb02eet when auto-scaling.

" + "smithy.api#documentation": "

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node.

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

The scaling configuration input of a compute fleet.

" + "smithy.api#documentation": "

Contains information about the Session Manager session.

" } }, - "com.amazonaws.codebuild#ScalingConfigurationOutput": { + "com.amazonaws.codebuild#Sandbox": { "type": "structure", "members": { - "scalingType": { - "target": "com.amazonaws.codebuild#FleetScalingType", + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The scaling type for a compute fleet.

" + "smithy.api#documentation": "

The ID of the sandbox.

" } }, - "targetTrackingScalingConfigs": { - "target": "com.amazonaws.codebuild#TargetTrackingScalingConfigurations", + "arn": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

A list of TargetTrackingScalingConfiguration objects.

" + "smithy.api#documentation": "

The ARN of the sandbox.

" } }, - "maxCapacity": { - "target": "com.amazonaws.codebuild#FleetCapacity", + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The maximum number of instances in the \ufb02eet when auto-scaling.

" + "smithy.api#documentation": "

The CodeBuild project name.

" } }, - "desiredCapacity": { - "target": "com.amazonaws.codebuild#FleetCapacity", + "requestTime": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

The desired number of instances in the \ufb02eet when auto-scaling.

" + "smithy.api#documentation": "

When the sandbox process was initially requested, expressed in Unix time format.

" + } + }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox process started, expressed in Unix time format.

" + } + }, + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox process ended, expressed in Unix time format.

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

The status of the sandbox.

" + } + }, + "source": { + "target": "com.amazonaws.codebuild#ProjectSource" + }, + "sourceVersion": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Any version identifier for the version of the sandbox to be built.

" + } + }, + "secondarySources": { + "target": "com.amazonaws.codebuild#ProjectSources", + "traits": { + "smithy.api#documentation": "

An array of ProjectSource objects.

" + } + }, + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "traits": { + "smithy.api#documentation": "

An array of ProjectSourceVersion objects.

" + } + }, + "environment": { + "target": "com.amazonaws.codebuild#ProjectEnvironment" + }, + "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

" + } + }, + "timeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", + "traits": { + "smithy.api#documentation": "

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this sandbox if it does not\n get marked as completed.

" + } + }, + "queuedTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", + "traits": { + "smithy.api#documentation": "

The number of minutes a sandbox is allowed to be queued before it times out.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.codebuild#VpcConfig" + }, + "logConfig": { + "target": "com.amazonaws.codebuild#LogsConfig" + }, + "encryptionKey": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the sandbox output\n artifacts.

" + } + }, + "serviceRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a service role used for this sandbox.

" + } + }, + "currentSession": { + "target": "com.amazonaws.codebuild#SandboxSession", + "traits": { + "smithy.api#documentation": "

The current session for the sandbox.

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

Contains sandbox information.

" + } + }, + "com.amazonaws.codebuild#SandboxIds": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#NonEmptyString" + } + }, + "com.amazonaws.codebuild#SandboxSession": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the sandbox session.

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

The status of the sandbox session.

" + } + }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox session started, expressed in Unix time format.

" + } + }, + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox session ended, expressed in Unix time format.

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

The current phase for the sandbox.

" + } + }, + "phases": { + "target": "com.amazonaws.codebuild#SandboxSessionPhases", + "traits": { + "smithy.api#documentation": "

An array of SandboxSessionPhase objects.

" + } + }, + "resolvedSourceVersion": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An identifier for the version of this sandbox's source code.

" + } + }, + "logs": { + "target": "com.amazonaws.codebuild#LogsLocation" + }, + "networkInterface": { + "target": "com.amazonaws.codebuild#NetworkInterface" + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the sandbox session.

" + } + }, + "com.amazonaws.codebuild#SandboxSessionPhase": { + "type": "structure", + "members": { + "phaseType": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The name of the sandbox phase.

" + } + }, + "phaseStatus": { + "target": "com.amazonaws.codebuild#StatusType", + "traits": { + "smithy.api#documentation": "

The current status of the sandbox phase. Valid values include:

\n
\n
FAILED
\n
\n

The sandbox phase failed.

\n
\n
FAULT
\n
\n

The sandbox phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The sandbox phase is still in progress.

\n
\n
STOPPED
\n
\n

The sandbox phase stopped.

\n
\n
SUCCEEDED
\n
\n

The sandbox phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The sandbox phase timed out.

\n
\n
" + } + }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox phase started, expressed in Unix time format.

" + } + }, + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sandbox phase ended, 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 sandbox's\n phase.

" + } + }, + "contexts": { + "target": "com.amazonaws.codebuild#PhaseContexts", + "traits": { + "smithy.api#documentation": "

An array of PhaseContext objects.

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

Contains information about the sandbox phase.

" + } + }, + "com.amazonaws.codebuild#SandboxSessionPhases": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#SandboxSessionPhase" + } + }, + "com.amazonaws.codebuild#Sandboxes": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#Sandbox" + } + }, + "com.amazonaws.codebuild#ScalingConfigurationInput": { + "type": "structure", + "members": { + "scalingType": { + "target": "com.amazonaws.codebuild#FleetScalingType", + "traits": { + "smithy.api#documentation": "

The scaling type for a compute fleet.

" + } + }, + "targetTrackingScalingConfigs": { + "target": "com.amazonaws.codebuild#TargetTrackingScalingConfigurations", + "traits": { + "smithy.api#documentation": "

A list of TargetTrackingScalingConfiguration objects.

" + } + }, + "maxCapacity": { + "target": "com.amazonaws.codebuild#FleetCapacity", + "traits": { + "smithy.api#documentation": "

The maximum number of instances in the \ufb02eet when auto-scaling.

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

The scaling configuration input of a compute fleet.

" + } + }, + "com.amazonaws.codebuild#ScalingConfigurationOutput": { + "type": "structure", + "members": { + "scalingType": { + "target": "com.amazonaws.codebuild#FleetScalingType", + "traits": { + "smithy.api#documentation": "

The scaling type for a compute fleet.

" + } + }, + "targetTrackingScalingConfigs": { + "target": "com.amazonaws.codebuild#TargetTrackingScalingConfigurations", + "traits": { + "smithy.api#documentation": "

A list of TargetTrackingScalingConfiguration objects.

" + } + }, + "maxCapacity": { + "target": "com.amazonaws.codebuild#FleetCapacity", + "traits": { + "smithy.api#documentation": "

The maximum number of instances in the \ufb02eet when auto-scaling.

" + } + }, + "desiredCapacity": { + "target": "com.amazonaws.codebuild#FleetCapacity", + "traits": { + "smithy.api#documentation": "

The desired number of instances in the \ufb02eet when auto-scaling.

" } } }, @@ -7769,7 +8531,7 @@ "scope": { "target": "com.amazonaws.codebuild#WebhookScopeType", "traits": { - "smithy.api#documentation": "

The type of scope for a GitHub or GitLab webhook.

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

The type of scope for a GitHub or GitLab webhook. The scope default is GITHUB_ORGANIZATION.

", "smithy.api#required": {} } } @@ -8488,6 +9250,174 @@ "smithy.api#output": {} } }, + "com.amazonaws.codebuild#StartCommandExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#StartCommandExecutionInput" + }, + "output": { + "target": "com.amazonaws.codebuild#StartCommandExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a command execution.

" + } + }, + "com.amazonaws.codebuild#StartCommandExecutionInput": { + "type": "structure", + "members": { + "sandboxId": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A sandboxId or sandboxArn.

", + "smithy.api#required": {} + } + }, + "command": { + "target": "com.amazonaws.codebuild#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "

The command that needs to be executed.

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

The command type.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#StartCommandExecutionOutput": { + "type": "structure", + "members": { + "commandExecution": { + "target": "com.amazonaws.codebuild#CommandExecution", + "traits": { + "smithy.api#documentation": "

Information about the requested command executions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codebuild#StartSandbox": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#StartSandboxInput" + }, + "output": { + "target": "com.amazonaws.codebuild#StartSandboxOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#AccountSuspendedException" + }, + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a sandbox.

" + } + }, + "com.amazonaws.codebuild#StartSandboxConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#StartSandboxConnectionInput" + }, + "output": { + "target": "com.amazonaws.codebuild#StartSandboxConnectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a sandbox connection.

" + } + }, + "com.amazonaws.codebuild#StartSandboxConnectionInput": { + "type": "structure", + "members": { + "sandboxId": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A sandboxId or sandboxArn.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#StartSandboxConnectionOutput": { + "type": "structure", + "members": { + "ssmSession": { + "target": "com.amazonaws.codebuild#SSMSession", + "traits": { + "smithy.api#documentation": "

Information about the Session Manager session.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codebuild#StartSandboxInput": { + "type": "structure", + "members": { + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CodeBuild project name.

" + } + }, + "idempotencyToken": { + "target": "com.amazonaws.codebuild#SensitiveString", + "traits": { + "smithy.api#documentation": "

A unique client token.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#StartSandboxOutput": { + "type": "structure", + "members": { + "sandbox": { + "target": "com.amazonaws.codebuild#Sandbox", + "traits": { + "smithy.api#documentation": "

Information about the requested sandbox.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codebuild#StatusType": { "type": "enum", "members": { @@ -8624,6 +9554,55 @@ "smithy.api#output": {} } }, + "com.amazonaws.codebuild#StopSandbox": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#StopSandboxInput" + }, + "output": { + "target": "com.amazonaws.codebuild#StopSandboxOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a sandbox.

" + } + }, + "com.amazonaws.codebuild#StopSandboxInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Information about the requested sandbox ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codebuild#StopSandboxOutput": { + "type": "structure", + "members": { + "sandbox": { + "target": "com.amazonaws.codebuild#Sandbox", + "traits": { + "smithy.api#documentation": "

Information about the requested sandbox.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codebuild#String": { "type": "string" }, diff --git a/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json b/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json index addef045..636bce5b 100644 --- a/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json +++ b/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json @@ -247,6 +247,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#GetSigningCertificate" }, + { + "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshToken" + }, { "target": "com.amazonaws.cognitoidentityprovider#GetUICustomization" }, @@ -1649,7 +1652,7 @@ } }, "traits": { - "smithy.api#documentation": "

The automated response to a risk level for adaptive authentication in full-function,\n or ENFORCED, mode. You can assign an action to each risk level that\n threat protection evaluates.

" + "smithy.api#documentation": "

The automated response to a risk level for adaptive authentication in full-function,\n or ENFORCED, mode. You can assign an action to each risk level that threat\n protection evaluates.

" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionsType": { @@ -1713,7 +1716,7 @@ "NotifyConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType", "traits": { - "smithy.api#documentation": "

The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify\n users in AccountTakeoverRiskConfiguration, Amazon Cognito sends an email message\n using the method and template that you set with this data type.

" + "smithy.api#documentation": "

The settings for composing and sending an email message when threat protection\n assesses a risk level with adaptive authentication. When you choose to notify users in\n AccountTakeoverRiskConfiguration, Amazon Cognito sends an email message using\n the method and template that you set with this data type.

" } }, "Actions": { @@ -2799,6 +2802,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#UnsupportedOperationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, @@ -4734,7 +4740,7 @@ } }, "traits": { - "smithy.api#documentation": "

One authentication event that Amazon Cognito logged in a user pool with threat protection active. Contains user and device metadata and a risk assessment from your user\n pool.

" + "smithy.api#documentation": "

One authentication event that Amazon Cognito logged in a user pool with threat protection\n active. Contains user and device metadata and a risk assessment from your user\n pool.

" } }, "com.amazonaws.cognitoidentityprovider#AuthEventsType": { @@ -5470,7 +5476,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings for user pool actions when Amazon Cognito detects compromised credentials with\n threat protection in full-function ENFORCED mode.

" + "smithy.api#documentation": "

Settings for user pool actions when Amazon Cognito detects compromised credentials with threat\n protection in full-function ENFORCED mode.

" } }, "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType": { @@ -6929,6 +6935,9 @@ "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolClientResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -7221,6 +7230,12 @@ "traits": { "smithy.api#documentation": "

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } + }, + "RefreshTokenRotation": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenRotationType", + "traits": { + "smithy.api#documentation": "

The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.

" + } } }, "traits": { @@ -7252,6 +7267,9 @@ "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, @@ -8047,6 +8065,9 @@ "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -9362,7 +9383,7 @@ } }, "traits": { - "smithy.api#documentation": "

The feedback that your application submitted to a threat protection event\n log, as displayed in an AdminListUserAuthEvents response.

" + "smithy.api#documentation": "

The feedback that your application submitted to a threat protection event log, as\n displayed in an AdminListUserAuthEvents response.

" } }, "com.amazonaws.cognitoidentityprovider#EventFilterType": { @@ -9586,6 +9607,23 @@ } } }, + "com.amazonaws.cognitoidentityprovider#FeatureType": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException": { "type": "structure", "members": { @@ -9622,7 +9660,7 @@ "StreamArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export.

" + "smithy.api#documentation": "

The ARN of an Amazon Data Firehose stream that's the destination for threat protection log\n export.

" } } }, @@ -10242,6 +10280,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenReuseException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Given a refresh token, issues new ID, access, and optionally refresh tokens for the\n user who owns the submitted token. This operation issues a new refresh token and\n invalidates the original refresh token after an optional grace period when refresh token\n rotation is enabled. If refresh token rotation is disabled, issues new ID and access\n tokens only.

" + } + }, + "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenRequest": { + "type": "structure", + "members": { + "RefreshToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid refresh token that can authorize the request for new tokens. When refresh\n token rotation is active in the requested app client, this token is invalidated after\n the request is complete.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The app client that issued the refresh token to the user who wants to request new\n tokens.

", + "smithy.api#required": {} + } + }, + "ClientSecret": { + "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The client secret of the requested app client, if the client has a secret.

" + } + }, + "DeviceKey": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", + "traits": { + "smithy.api#documentation": "

When you enable device remembering, Amazon Cognito issues a device key that you can use for\n device authentication that bypasses multi-factor authentication (MFA). To implement\n GetTokensFromRefreshToken in a user pool with device remembering, you\n must capture the device key from the initial authentication request. If your application\n doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must\n provide the confirmed device key in this request if device remembering is\n enabled in your user pool.

\n

For more information about device remembering, see Working with devices.

" + } + }, + "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 Lambda functions to user pool triggers.\n When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the\n Lambda function the pre token generation trigger.

\n

For more information, see \nUsing Lambda triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:

\n
    \n
  • \n

    Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Validate the ClientMetadata value.

    \n
    • \n
  • \n

    Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.

    \n
    • \n
\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenResponse": { + "type": "structure", + "members": { + "AuthenticationResult": { + "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#GetUICustomization": { "type": "operation", "input": { @@ -11054,6 +11190,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#UnsupportedOperationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, @@ -12507,13 +12646,13 @@ "S3Configuration": { "target": "com.amazonaws.cognitoidentityprovider#S3ConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket destination of user activity log export with threat protection. To activate this setting, your user pool must be on the \n Plus tier.

" + "smithy.api#documentation": "

The Amazon S3 bucket destination of user activity log export with threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.

" } }, "FirehoseConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#FirehoseConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon Data Firehose stream destination of user activity log export with threat protection. To activate this setting, your user pool must be on the \n Plus tier.

" + "smithy.api#documentation": "

The Amazon Data Firehose stream destination of user activity log export with threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.

" } } }, @@ -12814,7 +12953,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for Amazon SES email messages that threat protection sends to a\n user when your adaptive authentication automated response has a\n Notify action.

" + "smithy.api#documentation": "

The configuration for Amazon SES email messages that threat protection sends to a user when\n your adaptive authentication automated response has a Notify\n action.

" } }, "com.amazonaws.cognitoidentityprovider#NotifyEmailType": { @@ -12841,7 +12980,7 @@ } }, "traits": { - "smithy.api#documentation": "

The template for email messages that threat protection sends to a user when\n your threat protection automated response has a Notify\n action.

" + "smithy.api#documentation": "

The template for email messages that threat protection sends to a user when your\n threat protection automated response has a Notify action.

" } }, "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType": { @@ -13328,6 +13467,40 @@ "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" } }, + "com.amazonaws.cognitoidentityprovider#RefreshTokenReuseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is throw when your application requests token refresh with a refresh\n token that has been invalidated by refresh-token rotation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#RefreshTokenRotationType": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.cognitoidentityprovider#FeatureType", + "traits": { + "smithy.api#documentation": "

The state of refresh token rotation for the current app client.

", + "smithy.api#required": {} + } + }, + "RetryGracePeriodSeconds": { + "target": "com.amazonaws.cognitoidentityprovider#RetryGracePeriodSecondsType", + "traits": { + "smithy.api#documentation": "

When you request a token refresh with GetTokensFromRefreshToken, the\n original refresh token that you're rotating out can remain valid for a period of time of\n up to 60 seconds. This allows for client-side retries. When\n RetryGracePeriodSeconds is 0, the grace period is disabled\n and a successful request immediately invalidates the submitted refresh token.

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

The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.

" + } + }, "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType": { "type": "integer", "traits": { @@ -13787,6 +13960,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#RetryGracePeriodSecondsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 60 + } + } + }, "com.amazonaws.cognitoidentityprovider#RevokeToken": { "type": "operation", "input": { @@ -13877,7 +14059,7 @@ "CompromisedCredentialsRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType", "traits": { - "smithy.api#documentation": "

Settings for compromised-credentials actions and authentication types with threat protection in full-function ENFORCED mode.

" + "smithy.api#documentation": "

Settings for compromised-credentials actions and authentication types with threat\n protection in full-function ENFORCED mode.

" } }, "AccountTakeoverRiskConfiguration": { @@ -13900,7 +14082,7 @@ } }, "traits": { - "smithy.api#documentation": "

The settings of risk configuration for threat protection with threat protection in a user pool.

" + "smithy.api#documentation": "

The settings of risk configuration for threat protection with threat protection in a\n user pool.

" } }, "com.amazonaws.cognitoidentityprovider#RiskDecisionType": { @@ -13995,12 +14177,12 @@ "BucketArn": { "target": "com.amazonaws.cognitoidentityprovider#S3ArnType", "traits": { - "smithy.api#documentation": "

The ARN of an Amazon S3 bucket that's the destination for threat protection\n log export.

" + "smithy.api#documentation": "

The ARN of an Amazon S3 bucket that's the destination for threat protection log\n export.

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

Configuration for the Amazon S3 bucket destination of user activity log export with\n threat protection.

" + "smithy.api#documentation": "

Configuration for the Amazon S3 bucket destination of user activity log export with threat\n protection.

" } }, "com.amazonaws.cognitoidentityprovider#SESConfigurationSet": { @@ -16348,6 +16530,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -16512,6 +16697,12 @@ "traits": { "smithy.api#documentation": "

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } + }, + "RefreshTokenRotation": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenRotationType", + "traits": { + "smithy.api#documentation": "

The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.

" + } } }, "traits": { @@ -16543,6 +16734,9 @@ "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, @@ -17073,7 +17267,7 @@ "AdvancedSecurityMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityModeType", "traits": { - "smithy.api#documentation": "

The operating mode of threat protection for standard authentication types in\n your user pool, including username-password and secure remote password (SRP)\n authentication.

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

The operating mode of threat protection for standard authentication types in your user\n pool, including username-password and secure remote password (SRP) authentication.\n

", "smithy.api#required": {} } }, @@ -17266,7 +17460,7 @@ "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an\n IpAddress value that you send in the UserContextData\n parameter. The UserContextData parameter sends information to Amazon Cognito\n threat protection for risk analysis. You can send UserContextData when you\n sign in Amazon Cognito native users with the InitiateAuth and\n RespondToAuthChallenge API operations.

\n

When EnablePropagateAdditionalUserContextData is false, you can't send\n your user's source IP address to Amazon Cognito threat protection with unauthenticated API\n operations. EnablePropagateAdditionalUserContextData doesn't affect whether\n you can send a source IP address in a ContextData parameter with the\n authenticated API operations AdminInitiateAuth and\n AdminRespondToAuthChallenge.

\n

You can only activate EnablePropagateAdditionalUserContextData in an app\n client that has a client secret. For more information about propagation of user context\n data, see Adding user device and session data to API requests.

" + "smithy.api#documentation": "

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an\n IpAddress value that you send in the UserContextData\n parameter. The UserContextData parameter sends information to Amazon Cognito threat\n protection for risk analysis. You can send UserContextData when you sign in\n Amazon Cognito native users with the InitiateAuth and\n RespondToAuthChallenge API operations.

\n

When EnablePropagateAdditionalUserContextData is false, you can't send\n your user's source IP address to Amazon Cognito threat protection with unauthenticated API\n operations. EnablePropagateAdditionalUserContextData doesn't affect whether\n you can send a source IP address in a ContextData parameter with the\n authenticated API operations AdminInitiateAuth and\n AdminRespondToAuthChallenge.

\n

You can only activate EnablePropagateAdditionalUserContextData in an app\n client that has a client secret. For more information about propagation of user context\n data, see Adding user device and session data to API requests.

" } }, "AuthSessionValidity": { @@ -17274,6 +17468,12 @@ "traits": { "smithy.api#documentation": "

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } + }, + "RefreshTokenRotation": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenRotationType", + "traits": { + "smithy.api#documentation": "

The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.

" + } } }, "traits": { diff --git a/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json b/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json index 2077a223..3d698c83 100644 --- a/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json +++ b/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json @@ -1389,9 +1389,7 @@ "Sentiment": { "target": "com.amazonaws.connectcontactlens#SentimentValue", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The sentiment detected for this piece of transcript.

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

The sentiment detected for this piece of transcript.

" } }, "IssuesDetected": { diff --git a/connect/service/2017-08-08/connect-2017-08-08.json b/connect/service/2017-08-08/connect-2017-08-08.json index 70d9437d..1925d9f9 100644 --- a/connect/service/2017-08-08/connect-2017-08-08.json +++ b/connect/service/2017-08-08/connect-2017-08-08.json @@ -121,6 +121,12 @@ "smithy.api#enumValue": "UPDATE_CASE" } }, + "ASSIGN_SLA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGN_SLA" + } + }, "END_ASSOCIATED_TASKS": { "target": "smithy.api#Unit", "traits": { @@ -2815,6 +2821,27 @@ "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact\n is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

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

Type of SLA assignment.

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

The SLA configuration for Case SLA Assignment.

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

The AssignSla action definition.

" + } + }, "com.amazonaws.connect#AssociateAnalyticsDataSet": { "type": "operation", "input": { @@ -3877,7 +3904,7 @@ "DisconnectTimestamp": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the customer endpoint disconnected from Amazon Connect.

" + "smithy.api#documentation": "

The date and time that the customer endpoint disconnected from the current contact, in UTC\n time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date\n and time when that contact ended.

" } }, "InitialContactId": { @@ -5051,6 +5078,47 @@ } } }, + "com.amazonaws.connect#CaseSlaConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#SlaName", + "traits": { + "smithy.api#documentation": "

Name of an SLA.

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

Type of SLA for Case SlaAssignmentType.

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

Unique identifier of a Case field.

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

Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. \n The SLA is considered met if any one of these target field values matches the actual field value.

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

Target duration in minutes within which an SLA should be completed.

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

The SLA configuration for Case SlaAssignmentType.

" + } + }, "com.amazonaws.connect#Channel": { "type": "enum", "members": { @@ -7261,7 +7329,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

Only the EMAIL channel is supported. The supported initiation methods are: OUTBOUND,\n AGENT_REPLY, and FLOW.

\n \n

Creates a new EMAIL contact.

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

Only the EMAIL and VOICE channels are supported. The supported initiation methods for EMAIL are: OUTBOUND,\n AGENT_REPLY, and FLOW. For VOICE the supported initiation methods are TRANSFER and the subtype connect:ExternalAudio.

\n \n

Creates a new EMAIL or VOICE contact.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/create-contact", @@ -7645,7 +7713,7 @@ "RelatedContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The unique identifier for an Amazon Connect contact. This identifier is related to the\n contact starting.

" + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" } }, "Attributes": { @@ -7663,14 +7731,14 @@ "Channel": { "target": "com.amazonaws.connect#Channel", "traits": { - "smithy.api#documentation": "

The channel for the contact

\n \n

CreateContact only supports the EMAIL channel. The following information that states other\n channels are supported is incorrect. We are working to update this topic.

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

The channel for the contact

\n \n

CreateContact only supports the EMAIL and VOICE channels. The following information that states other\n channels are supported is incorrect. We are working to update this topic.

\n ", "smithy.api#required": {} } }, "InitiationMethod": { "target": "com.amazonaws.connect#ContactInitiationMethod", "traits": { - "smithy.api#documentation": "

Indicates how the contact was initiated.

\n \n

CreateContact only supports the following initiation methods: OUTBOUND, AGENT_REPLY, and\n FLOW. The following information that states other initiation methods are supported is incorrect.\n We are working to update this topic.

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

Indicates how the contact was initiated.

\n \n

CreateContact only supports the following initiation methods:

\n
    \n
  • \n

    For EMAIL: OUTBOUND, AGENT_REPLY, and\n FLOW.

    \n
    • \n
  • \n

    For VOICE: TRANSFER and the subtype connect:ExternalAudio.

    \n
    • \n
\n

The following information that states other initiation methods are supported is incorrect.\n We are working to update this topic.

\n ", "smithy.api#required": {} } }, @@ -7713,7 +7781,7 @@ "PreviousContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The ID of the previous contact when creating a transfer contact. This value can be provided\n only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens\n with external voice systems in the Amazon Connect Administrator\n Guide.

" + "smithy.api#documentation": "

The ID of the previous contact when creating a transfer contact. This value can be provided\n only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens\n with external voice systems in the Amazon Connect Administrator Guide.

" } } }, @@ -17874,6 +17942,12 @@ "traits": { "smithy.api#enumValue": "OnCaseUpdate" } + }, + "OnSlaBreach": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnSlaBreach" + } } } }, @@ -33759,6 +33833,12 @@ "smithy.api#documentation": "

Information about the update case action.

\n

Supported only for TriggerEventSource values: OnCaseCreate |\n OnCaseUpdate.

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

Information about the assign SLA action.

" + } + }, "EndAssociatedTasksAction": { "target": "com.amazonaws.connect#EndAssociatedTasksActionDefinition", "traits": { @@ -36771,7 +36851,7 @@ "TrafficType": { "target": "com.amazonaws.connect#TrafficType", "traits": { - "smithy.api#documentation": "

Denotes the class of traffic.

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

Denotes the class of traffic.

\n \n

Only the CAMPAIGN traffic type is supported.

\n ", "smithy.api#required": {} } }, @@ -36935,6 +37015,50 @@ } } }, + "com.amazonaws.connect#SlaAssignmentType": { + "type": "enum", + "members": { + "CASES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASES" + } + } + } + }, + "com.amazonaws.connect#SlaFieldValueUnionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#FieldValueUnion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.connect#SlaName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^.*[\\S]$" + } + }, + "com.amazonaws.connect#SlaType": { + "type": "enum", + "members": { + "CASE_FIELD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CaseField" + } + } + } + }, "com.amazonaws.connect#SnapshotVersion": { "type": "string" }, @@ -38083,7 +38207,7 @@ "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

A description of the voice contact that is shown to an agent in the Contact Control Panel\n (CCP).

" + "smithy.api#documentation": "

A description of the voice contact that appears in the agent's snapshot in the CCP logs. For\n more information about CCP logs, see Download and review CCP logs in\n the Amazon Connect Administrator Guide.

" } }, "References": { @@ -39082,7 +39206,7 @@ } ], "traits": { - "smithy.api#documentation": "

When a contact is being recorded, this API suspends recording whatever is selected in the\n flow configuration: call, screen, or both. If only call recording or only screen recording is\n enabled, then it would be suspended. For example, you might suspend the screen recording while\n collecting sensitive information, such as a credit card number. Then use ResumeContactRecording\n to restart recording the screen.

\n

The period of time that the recording is suspended is filled with silence in the final\n recording.

\n

Voice and screen recordings are supported.

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

When a contact is being recorded, this API suspends recording whatever is selected in the\n flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen\n recording is enabled, then it would be suspended. For example, you might suspend the screen\n recording while collecting sensitive information, such as a credit card number. Then use\n ResumeContactRecording\n to restart recording the screen.

\n

The period of time that the recording is suspended is filled with silence in the final recording.\n

\n

Voice (IVR, agent) and screen recordings are supported.

", "smithy.api#http": { "method": "POST", "uri": "/contact/suspend-recording", @@ -39446,6 +39570,15 @@ } } }, + "com.amazonaws.connect#TargetSlaMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 129600 + } + } + }, "com.amazonaws.connect#TaskActionDefinition": { "type": "structure", "members": { @@ -40362,7 +40495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transfers TASK or EMAIL\n contacts from one agent or queue to another agent or queue at any point\n after a contact is created. You can transfer a contact to another queue by providing the flow\n which orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.

\n

Note the following requirements:

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

Transfers TASK or EMAIL\n contacts from one agent or queue to another agent or queue at any point\n after a contact is created. You can transfer a contact to another queue by providing the flow\n which orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.

\n

Note the following requirements:

\n ", "smithy.api#http": { "method": "POST", "uri": "/contact/transfer", diff --git a/connectcases/service/2022-10-03/connectcases-2022-10-03.json b/connectcases/service/2022-10-03/connectcases-2022-10-03.json index 10be6583..f095d662 100644 --- a/connectcases/service/2022-10-03/connectcases-2022-10-03.json +++ b/connectcases/service/2022-10-03/connectcases-2022-10-03.json @@ -1840,7 +1840,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

\n \n

Creates a case in the specified Cases domain. Case system and custom fields are taken\n as an array id/value pairs with a declared data types.

\n

The following fields are required when creating a case:

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

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

\n \n

Creates a case in the specified Cases domain. Case system and custom fields are taken\n as an array id/value pairs with a declared data types.

\n

The following fields are required when creating a case:

\n ", "smithy.api#http": { "uri": "/domains/{domainId}/cases", "method": "POST" @@ -2037,7 +2037,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a domain, which is a container for all case data, such as cases, fields, templates\n and layouts. Each Amazon Connect instance can be associated with only one Cases\n domain.

\n \n

This will not associate your connect instance to Cases domain. Instead, use the\n Amazon Connect\n CreateIntegrationAssociation API. You need specific IAM\n permissions to successfully associate the Cases domain. For more information, see\n Onboard to Cases.

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

Creates a domain, which is a container for all case data, such as cases, fields, templates\n and layouts. Each Amazon Connect instance can be associated with only one Cases\n domain.

\n \n

This will not associate your connect instance to Cases domain. Instead, use the\n Amazon Connect\n CreateIntegrationAssociation API. You need specific IAM\n permissions to successfully associate the Cases domain. For more information, see\n Onboard to Cases.

\n ", "smithy.api#http": { "uri": "/domains", "method": "POST" @@ -2566,7 +2566,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Cases domain.

\n \n \n

After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this\n Amazon Connect instance. See DeleteIntegrationAssociation.

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

Deletes a Cases domain.

\n \n

After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this\n Amazon Connect instance. See DeleteIntegrationAssociation.

\n ", "smithy.api#http": { "uri": "/domains/{domainId}", "method": "DELETE" @@ -2691,7 +2691,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a layout from a cases template. You can delete up to 100 layouts per\n domain.

\n\n

After a layout is deleted:

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

Deletes a layout from a cases template. You can delete up to 100 layouts per\n domain.

\n

After a layout is deleted:

\n ", "smithy.api#http": { "uri": "/domains/{domainId}/layouts/{layoutId}", "method": "DELETE" @@ -2759,7 +2759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a cases template. You can delete up to 100 templates per domain.

\n\n

After a cases template is deleted:

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

Deletes a cases template. You can delete up to 100 templates per domain.

\n

After a cases template is deleted:

\n ", "smithy.api#http": { "uri": "/domains/{domainId}/templates/{templateId}", "method": "DELETE" @@ -3417,7 +3417,7 @@ "traits": { "smithy.api#documentation": "

String value type.

", "smithy.api#length": { - "max": 1500 + "max": 3000 } } }, @@ -5202,6 +5202,9 @@ { "target": "com.amazonaws.connectcases#AccessDeniedException" }, + { + "target": "com.amazonaws.connectcases#ConflictException" + }, { "target": "com.amazonaws.connectcases#InternalServerException" }, @@ -5301,6 +5304,12 @@ "traits": { "smithy.api#documentation": "

Represents the content of a File to be returned to agents.

" } + }, + "sla": { + "target": "com.amazonaws.connectcases#SlaContent", + "traits": { + "smithy.api#documentation": "

Represents the content of an SLA to be returned to agents.

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

A file of related items.

" } + }, + "sla": { + "target": "com.amazonaws.connectcases#SlaInputContent", + "traits": { + "smithy.api#documentation": "

Represents the content of an SLA to be created.

" + } } }, "traits": { @@ -5378,6 +5393,10 @@ { "value": "File", "name": "FILE" + }, + { + "value": "Sla", + "name": "SLA" } ] } @@ -5402,6 +5421,12 @@ "traits": { "smithy.api#documentation": "

A filter for related items of this type of File.

" } + }, + "sla": { + "target": "com.amazonaws.connectcases#SlaFilter", + "traits": { + "smithy.api#documentation": "

Filter for related items of type SLA.

" + } } }, "traits": { @@ -5879,6 +5904,219 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.connectcases#SlaCompletionTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.connectcases#SlaConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.connectcases#SlaName", + "traits": { + "smithy.api#documentation": "

Name of an SLA.

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

Type of SLA.

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

Status of an SLA.

", + "smithy.api#required": {} + } + }, + "fieldId": { + "target": "com.amazonaws.connectcases#FieldId", + "traits": { + "smithy.api#documentation": "

Unique identifier of a field.

" + } + }, + "targetFieldValues": { + "target": "com.amazonaws.connectcases#SlaFieldValueUnionList", + "traits": { + "smithy.api#documentation": "

Represents a list of target field values for the fieldId specified in SlaConfiguration.

" + } + }, + "targetTime": { + "target": "com.amazonaws.connectcases#SlaTargetTime", + "traits": { + "smithy.api#documentation": "

Target time by which an SLA should be completed.

", + "smithy.api#required": {} + } + }, + "completionTime": { + "target": "com.amazonaws.connectcases#SlaCompletionTime", + "traits": { + "smithy.api#documentation": "

Time at which an SLA was completed.

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

Represents an SLA configuration.

" + } + }, + "com.amazonaws.connectcases#SlaContent": { + "type": "structure", + "members": { + "slaConfiguration": { + "target": "com.amazonaws.connectcases#SlaConfiguration", + "traits": { + "smithy.api#documentation": "

Represents an SLA configuration.

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

Represents the content of an SLA to be returned to agents.

" + } + }, + "com.amazonaws.connectcases#SlaFieldValueUnionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcases#FieldValueUnion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.connectcases#SlaFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.connectcases#SlaName", + "traits": { + "smithy.api#documentation": "

Name of an SLA.

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

Status of an SLA.

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

A filter for related items of type SLA.

" + } + }, + "com.amazonaws.connectcases#SlaInputConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.connectcases#SlaName", + "traits": { + "smithy.api#documentation": "

Name of an SLA.

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

Type of SLA.

", + "smithy.api#required": {} + } + }, + "fieldId": { + "target": "com.amazonaws.connectcases#FieldId", + "traits": { + "smithy.api#documentation": "

Unique identifier of a field.

" + } + }, + "targetFieldValues": { + "target": "com.amazonaws.connectcases#SlaFieldValueUnionList", + "traits": { + "smithy.api#documentation": "

Represents a list of target field values for the fieldId specified in SlaInputConfiguration. \n The SLA is considered met if any one of these target field values matches the actual field value.

" + } + }, + "targetSlaMinutes": { + "target": "com.amazonaws.connectcases#TargetSlaMinutes", + "traits": { + "smithy.api#documentation": "

Target duration in minutes within which an SLA should be completed.

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

Represents the input configuration of an SLA being created.

" + } + }, + "com.amazonaws.connectcases#SlaInputContent": { + "type": "union", + "members": { + "slaInputConfiguration": { + "target": "com.amazonaws.connectcases#SlaInputConfiguration", + "traits": { + "smithy.api#documentation": "

Represents an input SLA configuration.

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

Represents the content of an SLA.

" + } + }, + "com.amazonaws.connectcases#SlaName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^.*[\\S]$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connectcases#SlaStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Overdue", + "name": "OVERDUE" + }, + { + "value": "Met", + "name": "MET" + }, + { + "value": "NotMet", + "name": "NOT_MET" + } + ] + } + }, + "com.amazonaws.connectcases#SlaTargetTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.connectcases#SlaType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CaseField", + "name": "CASE_FIELD" + } + ] + } + }, "com.amazonaws.connectcases#Sort": { "type": "structure", "members": { @@ -5995,6 +6233,15 @@ "smithy.api#sparse": {} } }, + "com.amazonaws.connectcases#TargetSlaMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 129600 + } + } + }, "com.amazonaws.connectcases#Template": { "type": "resource", "identifiers": { diff --git a/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json b/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json index ae91fed9..03e3b2bf 100644 --- a/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json +++ b/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json @@ -979,6 +979,35 @@ } } }, + "com.amazonaws.controlcatalog#ControlSeverity": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + } + } + }, "com.amazonaws.controlcatalog#ControlSummary": { "type": "structure", "members": { @@ -1002,6 +1031,30 @@ "smithy.api#documentation": "

A description of the control, as it may appear in the console. Describes the functionality of the control.

", "smithy.api#required": {} } + }, + "Behavior": { + "target": "com.amazonaws.controlcatalog#ControlBehavior", + "traits": { + "smithy.api#documentation": "

An enumerated type, with the following possible values:

" + } + }, + "Severity": { + "target": "com.amazonaws.controlcatalog#ControlSeverity", + "traits": { + "smithy.api#documentation": "

An enumerated type, with the following possible values:

" + } + }, + "Implementation": { + "target": "com.amazonaws.controlcatalog#ImplementationSummary", + "traits": { + "smithy.api#documentation": "

An object of type ImplementationSummary that describes how the control is implemented.

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

A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

" + } } }, "traits": { @@ -1202,6 +1255,12 @@ "smithy.api#required": {} } }, + "Severity": { + "target": "com.amazonaws.controlcatalog#ControlSeverity", + "traits": { + "smithy.api#documentation": "

An enumerated type, with the following possible values:

" + } + }, "RegionConfiguration": { "target": "com.amazonaws.controlcatalog#RegionConfiguration", "traits": { @@ -1219,6 +1278,12 @@ "traits": { "smithy.api#documentation": "

Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don\u2019t support parameters.\n

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

A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

" + } } }, "traits": { @@ -1234,12 +1299,49 @@ "smithy.api#documentation": "

A string that describes a control's implementation type.

", "smithy.api#required": {} } + }, + "Identifier": { + "target": "com.amazonaws.controlcatalog#ImplementationIdentifier", + "traits": { + "smithy.api#documentation": "

A service-specific identifier for the control, assigned by the service that implemented the control. For example, this identifier could be an Amazon Web Services Config Rule ID or a Security Hub Control ID.

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

An object that describes the implementation type for a control.

\n

Our ImplementationDetails\n Type format has three required segments:

\n \n

For example, AWS::Config::ConfigRule\n or\n AWS::SecurityHub::SecurityControl resources have the format with three required segments.

\n

Our ImplementationDetails\n Type format has an optional fourth segment, which is present for applicable \n implementation types. The format is as follows:

\n \n

For example, AWS::Organizations::Policy::SERVICE_CONTROL_POLICY\n or\n AWS::CloudFormation::Type::HOOK have the format with four segments.

\n

Although the format is similar, the values for the Type field do not match any Amazon Web Services CloudFormation values.

" } }, + "com.amazonaws.controlcatalog#ImplementationIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, + "com.amazonaws.controlcatalog#ImplementationSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.controlcatalog#ImplementationType", + "traits": { + "smithy.api#documentation": "

A string that represents the Amazon Web Services service that implements this control. For example, a value of AWS::Config::ConfigRule indicates that the control is implemented by Amazon Web Services Config, and AWS::SecurityHub::SecurityControl indicates implementation by Amazon Web Services Security Hub.

", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.controlcatalog#ImplementationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier originally assigned by the Amazon Web Services service that implements the control. For example, CODEPIPELINE_DEPLOYMENT_COUNT_CHECK.

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

A summary of how the control is implemented, including the Amazon Web Services service that enforces the control and its service-specific identifier. For example, the value of this field could indicate that the control is implemented as an Amazon Web Services Config Rule or an Amazon Web Services Security Hub control.

" + } + }, "com.amazonaws.controlcatalog#ImplementationType": { "type": "string", "traits": { diff --git a/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json b/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json index ea211701..dde8f997 100644 --- a/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json +++ b/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json @@ -3441,7 +3441,7 @@ "Key": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.

\n

Not all dimensions are supported in each API. Refer to the documentation for each\n specific API to see what is supported.

\n

\n LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

\n

\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

" + "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.

\n

Not all dimensions are supported in each API. Refer to the documentation for each\n specific API to see what is supported.

\n

\n LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

\n

\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

" } }, "Values": { @@ -4196,7 +4196,13 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object. Anomalies are available for up to 90\n days.

" + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object. Anomalies are available for up to 90\n days.

", + "smithy.api#paginated": { + "inputToken": "NextPageToken", + "outputToken": "NextPageToken", + "items": "Anomalies", + "pageSize": "MaxResults" + } } }, "com.amazonaws.costexplorer#GetAnomaliesRequest": { @@ -4285,7 +4291,13 @@ } ], "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).

" + "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).

", + "smithy.api#paginated": { + "inputToken": "NextPageToken", + "outputToken": "NextPageToken", + "items": "AnomalyMonitors", + "pageSize": "MaxResults" + } } }, "com.amazonaws.costexplorer#GetAnomalyMonitorsRequest": { @@ -4355,7 +4367,13 @@ } ], "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).

" + "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).

", + "smithy.api#paginated": { + "inputToken": "NextPageToken", + "outputToken": "NextPageToken", + "items": "AnomalySubscriptions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.costexplorer#GetAnomalySubscriptionsRequest": { @@ -4754,7 +4772,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "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\n by or filter by a ResourceId. It requires the Expression\n \"SERVICE = Amazon Elastic Compute Cloud - Compute\" in the filter.

\n

Valid values for MatchOptions for Dimensions are\n EQUALS and CASE_SENSITIVE.

\n

Valid values for MatchOptions for CostCategories and\n Tags are EQUALS, ABSENT, and\n CASE_SENSITIVE. Default values are EQUALS and\n CASE_SENSITIVE.

", + "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

Valid values for MatchOptions for Dimensions are\n EQUALS and CASE_SENSITIVE.

\n

Valid values for MatchOptions for CostCategories and\n Tags are EQUALS, ABSENT, and\n CASE_SENSITIVE. Default values are EQUALS and\n CASE_SENSITIVE.

", "smithy.api#required": {} } }, @@ -4991,7 +5009,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The\n GetCostForecast API supports filtering by the following dimensions:

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

The filters that you want to use to filter your forecast. The\n GetCostForecast API supports filtering by the following dimensions:

\n " } }, "BillingViewArn": { @@ -9709,7 +9727,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Request a cost allocation tag backfill. This will backfill the activation status (either active or inactive) for all tag keys from para:BackfillFrom up to the when this request is made.

\n

You can request a backfill once every 24 hours.\n

" + "smithy.api#documentation": "

\n Request a cost allocation tag backfill. This will backfill the activation status (either active or inactive) for all tag keys from para:BackfillFrom up to the time this request is made.

\n

You can request a backfill once every 24 hours.\n

" } }, "com.amazonaws.costexplorer#StartCostAllocationTagBackfillRequest": { diff --git a/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json b/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json index 9c416a60..81bcdb77 100644 --- a/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json +++ b/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json @@ -233,7 +233,7 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates\n recommendations including the management account and member accounts if the value is set to\n PAYER. If the value is LINKED, recommendations are calculated for\n individual member accounts only.

" + "smithy.api#documentation": "

The account scope for which you want recommendations. Amazon Web Services calculates\n recommendations including the management account and member accounts if the value is set to\n PAYER. If the value is LINKED, recommendations are calculated for\n individual member accounts only.

" } }, "term": { @@ -979,6 +979,91 @@ "smithy.api#documentation": "

The DB instance configuration used for recommendations.

" } }, + "com.amazonaws.costoptimizationhub#DynamoDbReservedCapacity": { + "type": "structure", + "members": { + "configuration": { + "target": "com.amazonaws.costoptimizationhub#DynamoDbReservedCapacityConfiguration", + "traits": { + "smithy.api#documentation": "

The DynamoDB reserved capacity configuration used for recommendations.

" + } + }, + "costCalculation": { + "target": "com.amazonaws.costoptimizationhub#ReservedInstancesCostCalculation" + } + }, + "traits": { + "smithy.api#documentation": "

The DynamoDB reserved capacity recommendation details.

", + "smithy.api#tags": [ + "db_recs" + ] + } + }, + "com.amazonaws.costoptimizationhub#DynamoDbReservedCapacityConfiguration": { + "type": "structure", + "members": { + "accountScope": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service for which you want recommendations.

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

The reserved capacity recommendation term in years.

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

The payment option for the commitment.

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

The Amazon Web Services Region of the commitment.

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

How much purchasing this reserved capacity costs you upfront.

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

How much purchasing this reserved capacity costs you on a monthly basis.

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

The number of reserved capacity units that Amazon Web Services recommends that you\n purchase.

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

The capacity unit of the recommended reservation.

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

The DynamoDB reserved capacity configuration used for recommendations.

", + "smithy.api#tags": [ + "db_recs" + ] + } + }, "com.amazonaws.costoptimizationhub#EbsVolume": { "type": "structure", "members": { @@ -1154,7 +1239,7 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

" } }, "term": { @@ -1218,19 +1303,13 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service that you want your recommendations for.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The service for which you want recommendations.

" } }, "term": { @@ -1245,6 +1324,30 @@ "smithy.api#documentation": "

The payment option for the commitment.

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

The Amazon Web Services Region of the commitment.

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

How much purchasing this instance costs you upfront.

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

How much purchasing these reserved instances costs you on a monthly basis.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + } + }, "numberOfInstancesToPurchase": { "target": "smithy.api#String", "traits": { @@ -1269,12 +1372,6 @@ "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

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

The Amazon Web Services Region of the commitment.

" - } - }, "currentGeneration": { "target": "smithy.api#String", "traits": { @@ -1298,18 +1395,6 @@ "traits": { "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

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

How much purchasing this instance costs you upfront.

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

How much purchasing reserved instances costs you on a monthly basis.

" - } } }, "traits": { @@ -1376,19 +1461,13 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service that you want your recommendations for.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The service for which you want recommendations.

" } }, "term": { @@ -1403,52 +1482,58 @@ "smithy.api#documentation": "

The payment option for the commitment.

" } }, - "numberOfInstancesToPurchase": { + "reservedInstancesRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" } }, - "instanceFamily": { + "upfrontCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, - "instanceType": { + "monthlyRecurringCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" + "smithy.api#documentation": "

How much purchasing these reserved instances costs you on a monthly basis.

" } }, - "reservedInstancesRegion": { + "normalizedUnitsToPurchase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" + "smithy.api#documentation": "

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" } }, - "currentGeneration": { + "numberOfInstancesToPurchase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" + "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" } }, - "sizeFlexEligible": { - "target": "smithy.api#Boolean", + "instanceFamily": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, - "upfrontCost": { + "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, - "monthlyRecurringCost": { + "currentGeneration": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing reserved instances costs you on a monthly basis.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

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

Determines whether the recommendation is size flexible.

" } } }, @@ -1523,7 +1608,7 @@ "accountIds": { "target": "com.amazonaws.costoptimizationhub#AccountIdList", "traits": { - "smithy.api#documentation": "

The account that the recommendation is for.

" + "smithy.api#documentation": "

The account to which the recommendation applies.

" } }, "regions": { @@ -1696,7 +1781,7 @@ "accountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account that the recommendation is for.

" + "smithy.api#documentation": "

The account to which the recommendation applies.

" } }, "currencyCode": { @@ -2266,6 +2351,115 @@ } } }, + "com.amazonaws.costoptimizationhub#MemoryDbReservedInstances": { + "type": "structure", + "members": { + "configuration": { + "target": "com.amazonaws.costoptimizationhub#MemoryDbReservedInstancesConfiguration", + "traits": { + "smithy.api#documentation": "

The MemoryDB reserved instances configuration used for recommendations.

" + } + }, + "costCalculation": { + "target": "com.amazonaws.costoptimizationhub#ReservedInstancesCostCalculation" + } + }, + "traits": { + "smithy.api#documentation": "

The MemoryDB reserved instances recommendation details.

\n \n

MemoryDB reserved instances are referred to as \"MemoryDB reserved nodes\" in\n customer-facing documentation.

\n ", + "smithy.api#tags": [ + "db_recs" + ] + } + }, + "com.amazonaws.costoptimizationhub#MemoryDbReservedInstancesConfiguration": { + "type": "structure", + "members": { + "accountScope": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service for which you want recommendations.

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

The reserved instances recommendation term in years.

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

The payment option for the commitment.

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

The Amazon Web Services Region of the commitment.

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

How much purchasing these reserved instances costs you upfront.

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

How much purchasing these reserved instances costs you on a monthly basis.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

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

The number of instances that Amazon Web Services recommends that you purchase.

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

The type of instance that Amazon Web Services recommends.

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

The instance family of the recommended reservation.

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

Determines whether the recommendation is size flexible.

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

Determines whether the recommendation is for a current generation instance.

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

The MemoryDB reserved instances configuration used for recommendations.

\n \n

MemoryDB reserved instances are referred to as \"MemoryDB reserved nodes\" in\n customer-facing documentation.

\n ", + "smithy.api#tags": [ + "db_recs" + ] + } + }, "com.amazonaws.costoptimizationhub#MixedInstanceConfiguration": { "type": "structure", "members": { @@ -2312,19 +2506,13 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service that you want your recommendations for.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The service for which you want recommendations.

" } }, "term": { @@ -2339,46 +2527,52 @@ "smithy.api#documentation": "

The payment option for the commitment.

" } }, - "numberOfInstancesToPurchase": { + "reservedInstancesRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" } }, - "instanceType": { + "upfrontCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, - "reservedInstancesRegion": { + "monthlyRecurringCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" + "smithy.api#documentation": "

How much purchasing these reserved instances costs you on a monthly basis.

" } }, - "currentGeneration": { + "normalizedUnitsToPurchase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" + "smithy.api#documentation": "

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" } }, - "sizeFlexEligible": { - "target": "smithy.api#Boolean", + "numberOfInstancesToPurchase": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

" + "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" } }, - "upfrontCost": { + "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, - "monthlyRecurringCost": { + "currentGeneration": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing reserved instances costs you on a monthly basis.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

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

Determines whether the recommendation is size flexible.

" } } }, @@ -2529,19 +2723,13 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service that you want your recommendations for.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The service for which you want recommendations.

" } }, "term": { @@ -2556,52 +2744,58 @@ "smithy.api#documentation": "

The payment option for the commitment.

" } }, - "numberOfInstancesToPurchase": { + "reservedInstancesRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" } }, - "instanceFamily": { + "upfrontCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, - "instanceType": { + "monthlyRecurringCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" + "smithy.api#documentation": "

How much purchasing this instance costs you on a monthly basis.

" } }, - "reservedInstancesRegion": { + "normalizedUnitsToPurchase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" + "smithy.api#documentation": "

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" } }, - "sizeFlexEligible": { - "target": "smithy.api#Boolean", + "numberOfInstancesToPurchase": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

" + "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" } }, - "currentGeneration": { + "instanceFamily": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, - "upfrontCost": { + "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, - "monthlyRecurringCost": { + "sizeFlexEligible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

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

How much purchasing this instance costs you on a monthly basis.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" } }, "licenseModel": { @@ -2645,7 +2839,7 @@ "accountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account that the recommendation is for.

" + "smithy.api#documentation": "

The account to which the recommendation applies.

" } }, "region": { @@ -2843,19 +3037,13 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

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

The service that you want your recommendations for.

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

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The service for which you want recommendations.

" } }, "term": { @@ -2870,52 +3058,58 @@ "smithy.api#documentation": "

The payment option for the commitment.

" } }, - "numberOfInstancesToPurchase": { + "reservedInstancesRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" } }, - "instanceFamily": { + "upfrontCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, - "instanceType": { + "monthlyRecurringCost": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" + "smithy.api#documentation": "

How much purchasing these reserved instances costs you on a monthly basis.

" } }, - "reservedInstancesRegion": { + "normalizedUnitsToPurchase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the commitment.

" + "smithy.api#documentation": "

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" } }, - "sizeFlexEligible": { - "target": "smithy.api#Boolean", + "numberOfInstancesToPurchase": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

" + "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" } }, - "currentGeneration": { + "instanceFamily": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, - "upfrontCost": { + "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, - "monthlyRecurringCost": { + "sizeFlexEligible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Determines whether the recommendation is size flexible.

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

How much purchasing reserved instances costs you on a monthly basis.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" } } }, @@ -3105,6 +3299,24 @@ "traits": { "smithy.api#documentation": "

The DB instance storage recommendation details.

" } + }, + "dynamoDbReservedCapacity": { + "target": "com.amazonaws.costoptimizationhub#DynamoDbReservedCapacity", + "traits": { + "smithy.api#documentation": "

The DynamoDB reserved capacity recommendation\n details.

", + "smithy.api#tags": [ + "db_recs" + ] + } + }, + "memoryDbReservedInstances": { + "target": "com.amazonaws.costoptimizationhub#MemoryDbReservedInstances", + "traits": { + "smithy.api#documentation": "

The MemoryDB reserved instances recommendation\n details.

", + "smithy.api#tags": [ + "db_recs" + ] + } } }, "traits": { @@ -3270,6 +3482,24 @@ "traits": { "smithy.api#enumValue": "RdsDbInstance" } + }, + "DYNAMO_DB_RESERVED_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DynamoDbReservedCapacity", + "smithy.api#tags": [ + "db_recs" + ] + } + }, + "MEMORY_DB_RESERVED_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MemoryDbReservedInstances", + "smithy.api#tags": [ + "db_recs" + ] + } } } }, @@ -3311,7 +3541,7 @@ "accountScope": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for.

" + "smithy.api#documentation": "

The account scope for which you want recommendations.

" } }, "term": { diff --git a/datazone/service/2018-05-10/datazone-2018-05-10.json b/datazone/service/2018-05-10/datazone-2018-05-10.json index 1e3cf53e..838e255a 100644 --- a/datazone/service/2018-05-10/datazone-2018-05-10.json +++ b/datazone/service/2018-05-10/datazone-2018-05-10.json @@ -1830,7 +1830,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 10 + "max": 20 } } }, diff --git a/deadline/service/2023-10-12/deadline-2023-10-12.json b/deadline/service/2023-10-12/deadline-2023-10-12.json index 89d92455..1874f631 100644 --- a/deadline/service/2023-10-12/deadline-2023-10-12.json +++ b/deadline/service/2023-10-12/deadline-2023-10-12.json @@ -414,8 +414,7 @@ "taskId": { "target": "com.amazonaws.deadline#TaskId", "traits": { - "smithy.api#documentation": "

The task ID.

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

The task ID.

" } }, "stepId": { @@ -1741,8 +1740,10 @@ ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, "name": "budget" - } + }, + "smithy.api#documentation": "Represents a budget that limits the expenses allowed on a queue or farm" } }, "com.amazonaws.deadline#BudgetSchedule": { @@ -2658,7 +2659,7 @@ "priority": { "target": "com.amazonaws.deadline#JobPriority", "traits": { - "smithy.api#documentation": "

The priority of the job on a scale of 0 to 100. The highest priority (first scheduled)\n is 100. When two jobs have the same priority, the oldest job is scheduled first.

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

The priority of the job. The highest priority (first scheduled) is 100. When two jobs\n have the same priority, the oldest job is scheduled first.

", "smithy.api#required": {} } }, @@ -3237,7 +3238,7 @@ "priority": { "target": "com.amazonaws.deadline#Priority", "traits": { - "smithy.api#documentation": "

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the\n highest priority. If two environments share the same priority value, the environment\n created first takes higher priority.

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

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the\n highest priority (activated first and deactivated last). If two environments share the same\n priority value, the environment created first takes higher priority.

", "smithy.api#required": {} } }, @@ -3687,9 +3688,17 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], "aws.iam#iamAction": { "name": "CreateWorker", - "documentation": "Grants permission to create a worker" + "documentation": "Grants permission to create a worker", + "requiredActions": [ + "deadline:TagResource", + "deadline:ListTagsForResource" + ] }, "smithy.api#documentation": "

Creates a worker. A worker tells your instance how much processing power (vCPU), and\n memory (GiB) you\u2019ll need to assemble the digital assets held within a particular instance.\n You can specify certain instance types to use, or let the worker know which instances types\n to exclude.

", "smithy.api#endpoint": { @@ -6702,7 +6711,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "farm" - } + }, + "smithy.api#documentation": "Represents a farm that contains Deadline Cloud queues and fleets" } }, "com.amazonaws.deadline#FarmSummaries": { @@ -6824,8 +6834,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[0-9A-Za-z ]*$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^[0-9A-Za-z ]*$" } }, "com.amazonaws.deadline#FileSystemLocationType": { @@ -7122,7 +7131,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "fleet" - } + }, + "smithy.api#documentation": "Represents a fleet of workers that process Deadline Cloud jobs" } }, "com.amazonaws.deadline#FleetStatus": { @@ -9449,7 +9459,7 @@ "processExitCode": { "target": "com.amazonaws.deadline#ProcessExitCode", "traits": { - "smithy.api#documentation": "

The exit code to exit the session.

" + "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.

" } }, "progressMessage": { @@ -11205,7 +11215,13 @@ "com.amazonaws.deadline#JobParameters": { "type": "map", "key": { - "target": "com.amazonaws.deadline#String" + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } }, "value": { "target": "com.amazonaws.deadline#JobParameter" @@ -11315,8 +11331,10 @@ ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, "name": "job" - } + }, + "smithy.api#documentation": "Represents the steps and tasks for a Deadline Cloud processing job" } }, "com.amazonaws.deadline#JobRunAsUser": { @@ -11711,7 +11729,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "license-endpoint" - } + }, + "smithy.api#documentation": "Represents a license endpoint that is for licensed software or a product used within Deadline Cloud" } }, "com.amazonaws.deadline#LicenseEndpointStatus": { @@ -14916,6 +14935,14 @@ "ids": { "licenseEndpointId": "resourceArn" } + }, + { + "resource": "com.amazonaws.deadline#WorkerResource", + "ids": { + "farmId": "resourceArn", + "fleetId": "resourceArn", + "workerId": "resourceArn" + } } ] } @@ -15466,8 +15493,10 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, "name": "metered-product" - } + }, + "smithy.api#documentation": "Represents a product with a license endpoint that is metered for use in Deadline Cloud" } }, "com.amazonaws.deadline#MeteredProductSummary": { @@ -15576,7 +15605,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "monitor" - } + }, + "smithy.api#documentation": "Represents a monitor that is used to manage Deadline Cloud resources" } }, "com.amazonaws.deadline#MonitorSummaries": { @@ -16404,7 +16434,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "queue" - } + }, + "smithy.api#documentation": "Represents a queue of Deadline Cloud jobs" } }, "com.amazonaws.deadline#QueueStatus": { @@ -17227,12 +17258,36 @@ "smithy.api#documentation": "

The term to search for.

", "smithy.api#required": {} } + }, + "matchType": { + "target": "com.amazonaws.deadline#SearchTermMatchingType", + "traits": { + "smithy.api#default": "FUZZY_MATCH", + "smithy.api#documentation": "

Specifies how Deadline Cloud matches your search term in the results. If you don't\n specify a matchType the default is FUZZY_MATCH.

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

Searches for a particular search term.

" } }, + "com.amazonaws.deadline#SearchTermMatchingType": { + "type": "enum", + "members": { + "FUZZY_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FUZZY_MATCH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } + } + }, "com.amazonaws.deadline#SearchWorkers": { "type": "operation", "input": { @@ -19187,6 +19242,14 @@ "ids": { "licenseEndpointId": "resourceArn" } + }, + { + "resource": "com.amazonaws.deadline#WorkerResource", + "ids": { + "farmId": "resourceArn", + "fleetId": "resourceArn", + "workerId": "resourceArn" + } } ] } @@ -19273,8 +19336,7 @@ "taskId": { "target": "com.amazonaws.deadline#TaskId", "traits": { - "smithy.api#documentation": "

The task ID.

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

The task ID.

" } }, "stepId": { @@ -19302,8 +19364,7 @@ "taskId": { "target": "com.amazonaws.deadline#TaskId", "traits": { - "smithy.api#documentation": "

The task ID.

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

The task ID.

" } }, "stepId": { @@ -19784,6 +19845,14 @@ "ids": { "licenseEndpointId": "resourceArn" } + }, + { + "resource": "com.amazonaws.deadline#WorkerResource", + "ids": { + "farmId": "resourceArn", + "fleetId": "resourceArn", + "workerId": "resourceArn" + } } ] } @@ -21655,7 +21724,7 @@ "processExitCode": { "target": "com.amazonaws.deadline#ProcessExitCode", "traits": { - "smithy.api#documentation": "

The process exit code.

" + "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.

" } }, "progressMessage": { @@ -22189,7 +22258,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "worker" - } + }, + "smithy.api#documentation": "Represents a worker that is part of a fleet on a farm" } }, "com.amazonaws.deadline#WorkerSearchSummaries": { diff --git a/detective/service/2018-10-26/detective-2018-10-26.json b/detective/service/2018-10-26/detective-2018-10-26.json index 82d2b7dc..9035281c 100644 --- a/detective/service/2018-10-26/detective-2018-10-26.json +++ b/detective/service/2018-10-26/detective-2018-10-26.json @@ -348,12 +348,6 @@ "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, @@ -373,6 +367,12 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" } }, "rules": [ @@ -404,152 +404,158 @@ "type": "error" }, { - "conditions": [ + "conditions": [], + "rules": [ { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, - true - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree" } ], "type": "tree" }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], + "conditions": [], "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { "ref": "Region" } - ], - "assign": "PartitionResult" + ] } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false ] }, { "fn": "booleanEquals", "argv": [ - true, + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://detective.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] - } + }, + "aws" ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://api.detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "type": "tree" + "endpoint": { + "url": "https://detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ { "fn": "getAttr", @@ -557,316 +563,376 @@ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] }, - true + "aws-us-gov" ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://api.detective-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "type": "tree" + "endpoint": { + "url": "https://detective.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] - } + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } ], "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://api.detective.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ], "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.detective.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.eu-north-1.amazonaws.com" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.detective-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.detective.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.detective.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "url": "https://api.detective.eu-south-1.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips enabled", "expect": { - "endpoint": { - "url": "https://api.detective.eu-west-1.amazonaws.com" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://api.detective.eu-west-2.amazonaws.com" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "eu-west-2", + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective.eu-west-3.amazonaws.com" + "url": "https://detective-fips.us-east-1.api.aws" } }, "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.me-south-1.amazonaws.com" + "url": "https://api.detective-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "me-south-1", - "UseFIPS": false, + "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective.sa-east-1.amazonaws.com" + "url": "https://detective.us-east-1.api.aws" } }, "params": { - "Region": "sa-east-1", + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { @@ -883,399 +949,301 @@ } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-east-1.amazonaws.com" + "url": "https://api.detective-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-east-1", + "Region": "cn-northwest-1", "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-east-2.amazonaws.com" + "url": "https://api.detective-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "us-east-2", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective.us-west-1.amazonaws.com" + "url": "https://api.detective.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-west-1", + "Region": "cn-northwest-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-west-1.amazonaws.com" + "url": "https://api.detective.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "us-west-1", - "UseFIPS": true, + "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective.us-west-2.amazonaws.com" + "url": "https://detective-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-west-2.amazonaws.com" + "url": "https://api.detective-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "us-west-2", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-east-1.api.aws" + "url": "https://detective.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, + "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-east-1.api.aws" + "url": "https://api.detective.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://api.detective-fips.cn-north-1.api.amazonwebservices.com.cn" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "cn-north-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.cn-north-1.amazonaws.com.cn" + "url": "https://api.detective-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "cn-north-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://api.detective.cn-north-1.api.amazonwebservices.com.cn" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "cn-north-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-gov-east-1.amazonaws.com" + "url": "https://api.detective.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://api.detective-fips.us-gov-east-1.amazonaws.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-gov-east-1", + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.detective.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-gov-west-1.amazonaws.com" + "url": "https://api.detective-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "Region": "us-gov-west-1", + "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://api.detective-fips.us-gov-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, + "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-gov-east-1.api.aws" + "url": "https://api.detective.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", "expect": { "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://api.detective-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { - "Region": "us-iso-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", "expect": { "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-iso-east-1.c2s.ic.gov" + "url": "https://api.detective.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { - "Region": "us-iso-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", "expect": { "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", + "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://api.detective-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { - "Region": "us-isob-east-1", + "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", "expect": { "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", + "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-isob-east-1.sc2s.sgov.gov" + "url": "https://api.detective.us-isof-south-1.csp.hci.ic.gov" } }, "params": { - "Region": "us-isob-east-1", + "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, { "documentation": "Missing region", "expect": { diff --git a/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json b/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json index 521c154f..6c35674d 100644 --- a/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json +++ b/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json @@ -76,6 +76,20 @@ ], "traits": { "smithy.api#documentation": "

Adds an existing user, group, or computer as a group member.

", + "smithy.api#examples": [ + { + "title": "To add a member to the Marketing group", + "documentation": "The following command adds an existing user to the Marketing group in the europe.example.com domain.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "GroupName": "Marketing", + "MemberName": "Pat Candella", + "MemberRealm": "europe.example.com" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/GroupMemberships/AddGroupMember", "method": "POST" @@ -238,6 +252,32 @@ ], "traits": { "smithy.api#documentation": "

Creates a new group.

", + "smithy.api#examples": [ + { + "title": "To create a group", + "documentation": "The following command creates a distribution list group named AcctngMail.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "GroupScope": "DomainLocal", + "GroupType": "Distribution", + "OtherAttributes": { + "displayName": { + "S": "Acctng-mailing-list" + }, + "description": { + "S": "Accounting dept mailing list" + } + }, + "SAMAccountName": "AcctngMail" + }, + "output": { + "DirectoryId": "d-12233abcde", + "SAMAccountName": "AcctngMail", + "SID": "S-1-5-33-123" + } + } + ], "smithy.api#http": { "uri": "/Groups/CreateGroup", "method": "POST" @@ -348,6 +388,33 @@ ], "traits": { "smithy.api#documentation": "

Creates a new user.

", + "smithy.api#examples": [ + { + "title": "To create a new user in the directory", + "documentation": "The following command", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "EmailAddress": "pcandella@exampledomain.com", + "GivenName": "Pat Candella", + "OtherAttributes": { + "department": { + "S": "HR" + }, + "homePhone": { + "S": "212-555-0100" + } + }, + "SAMAccountName": "pcandella", + "Surname": "Candella" + }, + "output": { + "DirectoryId": "d-12233abcde", + "SAMAccountName": "pcandella", + "SID": "S-1-5-99-789" + } + } + ], "smithy.api#http": { "uri": "/Users/CreateUser", "method": "POST" @@ -467,6 +534,18 @@ ], "traits": { "smithy.api#documentation": "

Deletes a group.

", + "smithy.api#examples": [ + { + "title": "To delete a group", + "documentation": "The following command deletes the marketing group from the specified directory.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "SAMAccountName": "marketing" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/Groups/DeleteGroup", "method": "POST" @@ -543,6 +622,18 @@ ], "traits": { "smithy.api#documentation": "

Deletes a user.

", + "smithy.api#examples": [ + { + "title": "To delete a user", + "documentation": "The following command deletes a group from the directory.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "SAMAccountName": "pcandella" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/Users/DeleteUser", "method": "POST" @@ -616,6 +707,41 @@ ], "traits": { "smithy.api#documentation": "

Returns information about a specific group.

", + "smithy.api#examples": [ + { + "title": "To return the attributes of a group", + "documentation": "The following command returns the mapped attributes for a group along with the display name, description, and GUID for the group.", + "input": { + "DirectoryId": "d-12233abcde", + "OtherAttributes": [ + "displayName", + "description", + "objectGUID" + ], + "Realm": "example.domain.com", + "SAMAccountName": "DevOpsMail" + }, + "output": { + "DirectoryId": "d-12233abcde", + "DistinguishedName": "DevOpsmail", + "GroupScope": "Global", + "GroupType": "Distribution", + "OtherAttributes": { + "displayName": { + "S": "DevOps mailing list" + }, + "description": { + "S": "A group for DevOps email." + }, + "objectGUID": { + "S": "123456789" + } + }, + "SAMAccountName": "DevOpsMail", + "SID": "S-1-5-55-678" + } + } + ], "smithy.api#http": { "uri": "/Groups/DescribeGroup", "method": "POST" @@ -668,7 +794,7 @@ "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#LdapDisplayNameList", "traits": { - "smithy.api#documentation": "

One or more attributes to be returned for the group. For a list of supported attributes,\n see Directory Service Data Attributes.\n

" + "smithy.api#documentation": "

One or more attributes to be returned for the group. For a list of supported attributes,\n see Directory Service Data Attributes.\n

" } } }, @@ -762,6 +888,48 @@ ], "traits": { "smithy.api#documentation": "

Returns information about a specific user.

", + "smithy.api#examples": [ + { + "title": "To return the attributes of a user", + "documentation": "The following command returns the mapped attributes for a user along with the department, manager, IP phone, and date the user last set a password.", + "input": { + "DirectoryId": "d-12233abcde", + "OtherAttributes": [ + "department", + "manager", + "ipPhone", + "pwdLastSet" + ], + "Realm": "examplecorp.com", + "SAMAccountName": "twhitlock" + }, + "output": { + "DirectoryId": "d-12233abcde", + "DistinguishedName": "Terry Whitlock", + "EmailAddress": "terry.whitlock@examplecorp.com", + "Enabled": true, + "GivenName": "Terry Whitlock", + "OtherAttributes": { + "department": { + "S": "communications" + }, + "manager": { + "S": "OU=Users,DC=mmajors" + }, + "ipPhone": { + "S": "111.111.111.111" + }, + "pwdLastSet": { + "N": 0 + } + }, + "SAMAccountName": "twhitlock", + "SID": "123-456-7890", + "Surname": "Whitlock", + "UserPrincipalName": "terry.whitlock" + } + } + ], "smithy.api#http": { "uri": "/Users/DescribeUser", "method": "POST" @@ -858,7 +1026,7 @@ "UserPrincipalName": { "target": "com.amazonaws.directoryservicedata#UserPrincipalName", "traits": { - "smithy.api#documentation": "

The UPN that is an Internet-style login name for a user and is based on the Internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.

" + "smithy.api#documentation": "

The UPN that is an Internet-style login name for a user and is based on the Internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.

" } }, "EmailAddress": { @@ -1729,6 +1897,18 @@ ], "traits": { "smithy.api#documentation": "

Deactivates an active user account. For information about how to enable an inactive user\n account, see ResetUserPassword\n in the Directory Service API Reference.

", + "smithy.api#examples": [ + { + "title": "To disable a user account", + "documentation": "The following command disables the account for twhitlock.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "SAMAccountName": "twhitlock" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/Users/DisableUser", "method": "POST" @@ -2020,6 +2200,38 @@ ], "traits": { "smithy.api#documentation": "

Returns member information for the specified group.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupMembers.NextToken member contains a token that you pass in the next\n call to ListGroupMembers. This retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To list members of a group", + "documentation": "The following command lists Marketing users in the trusted domain example.local.", + "input": { + "DirectoryId": "d-12233abcde", + "SAMAccountName": "marketing", + "MemberRealm": "example.local", + "Realm": "examplecorp.com" + }, + "output": { + "DirectoryId": "d-12233abcde", + "Members": [ + { + "SID": "S-1-5-11-111", + "SAMAccountName": "twhitlock", + "MemberType": "USER" + }, + { + "SID": "S-1-5-11-112", + "SAMAccountName": "pcandella", + "MemberType": "USER" + }, + { + "SID": "S-1-5-11-113", + "SAMAccountName": "jstiles", + "MemberType": "USER" + } + ] + } + } + ], "smithy.api#http": { "uri": "/GroupMemberships/ListGroupMembers", "method": "POST" @@ -2145,6 +2357,36 @@ ], "traits": { "smithy.api#documentation": "

Returns group information for the specified directory.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListGroups.NextToken\n member contains a token that you pass in the next call to ListGroups. This\n retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To list domain groups", + "documentation": "The following command lists the name and default attributes for groups on the examplecorp.com domain.", + "input": { + "DirectoryId": "d-12233abcde", + "MaxResults": 123, + "NextToken": "123456", + "Realm": "examplecorp.com" + }, + "output": { + "DirectoryId": "d-12233abcde", + "Groups": [ + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Administrators", + "SID": "S-1-5-32-544" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Users", + "SID": "S-1-5-32-545" + } + ], + "NextToken": "223456" + } + } + ], "smithy.api#http": { "uri": "/Groups/ListGroups", "method": "POST" @@ -2188,6 +2430,35 @@ ], "traits": { "smithy.api#documentation": "

Returns group information for the specified member.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupsForMember.NextToken member contains a token that you pass in the next\n call to ListGroupsForMember. This retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To list groups for a member", + "documentation": "The following command", + "input": { + "DirectoryId": "d-12233abcde", + "SAMAccountName": "twhitlock", + "MemberRealm": "example.local", + "Realm": "examplecorp.com" + }, + "output": { + "DirectoryId": "d-12233abcde", + "Groups": [ + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Administrators", + "SID": "S-1-5-32-544" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Users", + "SID": "S-1-5-32-545" + } + ] + } + } + ], "smithy.api#http": { "uri": "/GroupMemberships/ListGroupsForMember", "method": "POST" @@ -2379,6 +2650,36 @@ ], "traits": { "smithy.api#documentation": "

Returns user information for the specified directory.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListUsers.NextToken\n member contains a token that you pass in the next call to ListUsers. This\n retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To list users in a realm", + "documentation": "The following command lists users on the examplecorp.com domain.", + "input": { + "DirectoryId": "d-12233abcde", + "Realm": "examplecorp.com" + }, + "output": { + "DirectoryId": "d-12233abcde", + "Users": [ + { + "SID": "S-1-5-11-111", + "SAMAccountName": "twhitlock", + "Enabled": true + }, + { + "SID": "S-1-5-11-112", + "SAMAccountName": "pcandella", + "Enabled": true + }, + { + "SID": "S-1-5-11-113", + "SAMAccountName": "jstiles", + "Enabled": true + } + ] + } + } + ], "smithy.api#http": { "uri": "/Users/ListUsers", "method": "POST" @@ -2594,6 +2895,20 @@ ], "traits": { "smithy.api#documentation": "

Removes a member from a group.

", + "smithy.api#examples": [ + { + "title": "To remove a member from a group", + "documentation": "The following command removes the specified member from the example.local domain.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "GroupName": "DevOps", + "MemberName": "Pat Candella", + "MemberRealm": "example.local" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/GroupMemberships/RemoveGroupMember", "method": "POST" @@ -2699,6 +3014,40 @@ ], "traits": { "smithy.api#documentation": "

Searches the specified directory for a group. You can find groups that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchGroups.NextToken\n member contains a token that you pass in the next call to SearchGroups. This\n retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To search for groups", + "documentation": "The following command searches the examplecorp.com domain for groups with the GroupType security.", + "input": { + "DirectoryId": "d-12233abcde", + "MaxResults": 123, + "NextToken": "123456", + "Realm": "examplecorp.com", + "SearchAttributes": [ + "GroupScope" + ], + "SearchString": "Security" + }, + "output": { + "DirectoryId": "d-12233abcde", + "Groups": [ + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Administrators", + "SID": "S-1-5-32-544" + }, + { + "GroupScope": "BuiltinLocal", + "GroupType": "Security", + "SAMAccountName": "Users", + "SID": "S-1-5-32-545" + } + ], + "NextToken": "223456" + } + } + ], "smithy.api#http": { "uri": "/Groups/SearchGroups", "method": "POST" @@ -2829,6 +3178,41 @@ ], "traits": { "smithy.api#documentation": "

Searches the specified directory for a user. You can find users that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.

\n

This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchUsers.NextToken\n member contains a token that you pass in the next call to SearchUsers. This\n retrieves the next set of items.

\n

You can also specify a maximum number of return results with the MaxResults\n parameter.

", + "smithy.api#examples": [ + { + "title": "To search for users", + "documentation": "The following command searches for users in the domain based on the SearchAttributes.", + "input": { + "DirectoryId": "d-12233abcde", + "Realm": "examplecorp.com", + "SearchAttributes": [ + "department" + ], + "SearchString": "DevOps" + }, + "output": { + "DirectoryId": "d-12233abcde", + "NextToken": "223456", + "Users": [ + { + "SID": "S-1-5-11-111", + "SAMAccountName": "twhitlock", + "EmailAddress": "twhitlock@examplecorp.com" + }, + { + "SID": "S-1-5-11-112", + "SAMAccountName": "pcandella", + "EmailAddress": "pcandella@examplecorp.com" + }, + { + "SID": "S-1-5-11-113", + "SAMAccountName": "jstiles", + "EmailAddress": "jstiles@examplecorp.com" + } + ] + } + } + ], "smithy.api#http": { "uri": "/Users/SearchUsers", "method": "POST" @@ -3014,6 +3398,29 @@ ], "traits": { "smithy.api#documentation": "

Updates group information.

", + "smithy.api#examples": [ + { + "title": "To update a group", + "documentation": "The following command updates the preferred language and country attributes for the GuestsLocal group.", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "GroupScope": "Global", + "GroupType": "Security", + "OtherAttributes": { + "preferredLanguage": { + "S": "English" + }, + "co": { + "S": "US" + } + }, + "SAMAccountName": "GuestsLocal", + "UpdateType": "REPLACE" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/Groups/UpdateGroup", "method": "POST" @@ -3137,6 +3544,45 @@ ], "traits": { "smithy.api#documentation": "

Updates user information.

", + "smithy.api#examples": [ + { + "title": "To update user attributes", + "documentation": "The following command", + "input": { + "ClientToken": "550e8400-e29b-41d4-a716-446655440000", + "DirectoryId": "d-12233abcde", + "EmailAddress": "twhitlock@examplecorp.com", + "GivenName": "Terry", + "OtherAttributes": { + "telephoneNumber": { + "S": "212-555-1111" + }, + "homePhone": { + "S": "333-333-3333" + }, + "physicalDeliveryOfficeName": { + "S": "Example Company" + }, + "streetAddress": { + "S": "123 Any Street" + }, + "postalCode": { + "S": "54321" + }, + "st": { + "S": "WA" + }, + "co": { + "S": "US" + } + }, + "SAMAccountName": "twhitlock", + "Surname": "Whitlock", + "UpdateType": "ADD" + }, + "output": {} + } + ], "smithy.api#http": { "uri": "/Users/UpdateUser", "method": "POST" @@ -3182,7 +3628,7 @@ "OtherAttributes": { "target": "com.amazonaws.directoryservicedata#Attributes", "traits": { - "smithy.api#documentation": "

An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.

\n \n

Attribute names are case insensitive.

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

An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.

\n \n

Attribute names are case insensitive.

\n " } }, "UpdateType": { @@ -3235,7 +3681,7 @@ "UserPrincipalName": { "target": "com.amazonaws.directoryservicedata#UserPrincipalName", "traits": { - "smithy.api#documentation": "

The UPN that is an internet-style login name for a user and based on the internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.

" + "smithy.api#documentation": "

The UPN that is an internet-style login name for a user and based on the internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.

" } }, "EmailAddress": { diff --git a/dsql/service/2018-05-10/dsql-2018-05-10.json b/dsql/service/2018-05-10/dsql-2018-05-10.json index 1a919392..ef698753 100644 --- a/dsql/service/2018-05-10/dsql-2018-05-10.json +++ b/dsql/service/2018-05-10/dsql-2018-05-10.json @@ -75,6 +75,11 @@ "list": { "target": "com.amazonaws.dsql#ListClusters" }, + "operations": [ + { + "target": "com.amazonaws.dsql#GetVpcEndpointServiceName" + } + ], "collectionOperations": [ { "target": "com.amazonaws.dsql#CreateMultiRegionClusters" @@ -118,7 +123,8 @@ "com.amazonaws.dsql#ClusterId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of the cluster" + "smithy.api#documentation": "The ID of the cluster", + "smithy.api#pattern": "^[a-z0-9]{26}$" } }, "com.amazonaws.dsql#ClusterList": { @@ -1053,7 +1059,7 @@ { "id": "GetClusterNotFound", "params": { - "identifier": "someIdentifier" + "identifier": "ruabtlcu6nqjdl6k6jjcug67ta" }, "expect": { "failure": { @@ -1170,6 +1176,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.dsql#GetVpcEndpointServiceName": { + "type": "operation", + "input": { + "target": "com.amazonaws.dsql#GetVpcEndpointServiceNameInput" + }, + "output": { + "target": "com.amazonaws.dsql#GetVpcEndpointServiceNameOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dsql#InternalServerException" + }, + { + "target": "com.amazonaws.dsql#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dsql#ThrottlingException" + }, + { + "target": "com.amazonaws.dsql#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get the VPC Endpoint Service Name for a cluster" + }, + "smithy.api#documentation": "

Retrieves the VPC endpoint service name.

", + "smithy.api#examples": [ + { + "title": "Get VPC Endpoint Service Name", + "input": { + "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/clusters/{identifier}/vpc-endpoint-service-name", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetVpcEndpointServiceNameNotFound", + "params": { + "identifier": "ruabtlcu6nqjdl6k6jjcug67ta" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.dsql#ResourceNotFoundException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.dsql#GetVpcEndpointServiceNameInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.dsql#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the cluster to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dsql#GetVpcEndpointServiceNameOutput": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.dsql#ServiceName", + "traits": { + "smithy.api#documentation": "

The VPC endpoint service name.

", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dsql#InternalServerException": { "type": "structure", "members": { @@ -1440,6 +1538,17 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.dsql#ServiceName": { + "type": "string", + "traits": { + "smithy.api#documentation": "VPC Endpoint Service name for a Cluster", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^com\\.amazonaws\\.[a-z0-9-]+\\.dsql-[a-f0-9]{6}$" + } + }, "com.amazonaws.dsql#ServiceQuotaExceededException": { "type": "structure", "members": { diff --git a/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json b/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json index fe628732..d56c104b 100644 --- a/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json +++ b/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json @@ -788,7 +788,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB\n .

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n \n \n

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

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

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n \n \n

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

\n " } }, "com.amazonaws.dynamodb#BatchExecuteStatementInput": { @@ -858,7 +858,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

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

The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

\n \n

\n BatchGetItem will result in a ValidationException if the\n same key is specified multiple times.

\n ", "smithy.api#examples": [ { "title": "To retrieve multiple items from a table", @@ -1639,7 +1639,7 @@ } }, "traits": { - "smithy.api#documentation": "

A condition specified in the operation could not be evaluated.

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

A condition specified in the operation failed to be evaluated.

", "smithy.api#error": "client" } }, @@ -1984,7 +1984,7 @@ "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { - "smithy.api#documentation": "

The maximum number of read and write units for the global secondary index being\n created. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + "smithy.api#documentation": "

The maximum number of read and write units for the global secondary index being\n created. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both. You must use either\n OnDemand Throughput or ProvisionedThroughput based on your table's\n capacity mode.

" } }, "WarmThroughput": { @@ -2188,19 +2188,19 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.

\n

Each local secondary index in the array includes the following:

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

One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.

\n

Each local secondary index in the array includes the following:

\n " } }, "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.\n Each global secondary index in the array includes the following:

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

One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:

\n " } }, "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " } }, "ProvisionedThroughput": { @@ -2242,7 +2242,7 @@ "WarmThroughput": { "target": "com.amazonaws.dynamodb#WarmThroughput", "traits": { - "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second) for creating a table.

" + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second)\n for creating a table.

" } }, "ResourcePolicy": { @@ -2919,7 +2919,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.

" + "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the\n recovery period to any value between 1 and 35 days.

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.

" } }, "com.amazonaws.dynamodb#DescribeContinuousBackupsInput": { @@ -16897,7 +16897,7 @@ "RecoveryPeriodInDays": { "target": "com.amazonaws.dynamodb#RecoveryPeriodInDays", "traits": { - "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional. If no value is provided, the value will\n default to 35.

" + "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional.

" } }, "EarliestRestorableDateTime": { @@ -17036,7 +17036,7 @@ "NonKeyAttributes": { "target": "com.amazonaws.dynamodb#NonKeyAttributeNameList", "traits": { - "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.

" + "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For global and local secondary indexes, the total count of NonKeyAttributes summed\n across all of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total. This limit only applies when you specify the ProjectionType of\n INCLUDE. You still can specify the ProjectionType of ALL to\n project all attributes from the source table, even if the table has more than 100\n attributes.

" } } }, @@ -17089,7 +17089,7 @@ } }, "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

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index. You must use ProvisionedThroughput or\n OnDemandThroughput based on your table\u2019s capacity mode.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { @@ -17693,7 +17693,7 @@ "target": "com.amazonaws.dynamodb#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" + "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" } }, "LastEvaluatedKey": { @@ -18394,7 +18394,7 @@ } }, "traits": { - "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. Please contact\n Amazon Web Services Support to request a\n quota increase.

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

Throughput exceeds the current throughput quota for your account. Please contact\n Amazon Web ServicesSupport to request a\n quota increase.

", "smithy.api#error": "client" } }, @@ -18625,7 +18625,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of\n users can execute up to 50 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

\n

Along with data, the following are also included on the new restored table using point\n in time recovery:

\n \n

You must manually set up the following on the restored table:

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

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time in the last 35 days. You can set the\n recovery period to any value between 1 and 35 days. Any number of users can execute up\n to 50 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

\n

Along with data, the following are also included on the new restored table using point\n in time recovery:

\n \n

You must manually set up the following on the restored table:

\n " } }, "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { @@ -19704,13 +19704,13 @@ "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\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n 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\n be returned.

" + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n 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\n be returned.

" } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" } }, "StreamSpecification": { @@ -19907,12 +19907,12 @@ "Status": { "target": "com.amazonaws.dynamodb#TableStatus", "traits": { - "smithy.api#documentation": "

Represents warm throughput value of the base table..

" + "smithy.api#documentation": "

Represents warm throughput value of the base table.

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

Represents the warm throughput value (in read units per second and write units per\n second) of the base table.

" + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per second)\n of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and specifies\n the minimum provisioned capacity maintained for immediate data access.

" } }, "com.amazonaws.dynamodb#Tag": { @@ -19987,7 +19987,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#TagResourceInput": { @@ -20303,7 +20303,12 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

\n TransactWriteItems is a synchronous write operation that groups up to 100\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.

\n

The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:

\n \n

DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:

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

\n TransactWriteItems is a synchronous write operation that groups up to 100\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.

\n

The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:

\n \n

DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:

\n ", + "smithy.rules#operationContextParams": { + "ResourceArnList": { + "path": "TransactItems[*].[ConditionCheck.TableName, Put.TableName, Delete.TableName, Update.TableName][]" + } + } } }, "com.amazonaws.dynamodb#TransactWriteItemsInput": { @@ -20428,7 +20433,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#UntagResourceInput": { @@ -20535,7 +20540,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.

" + "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the\n RecoveryPeriodInDays to any value between 1 and 35 days.

" } }, "com.amazonaws.dynamodb#UpdateContinuousBackupsInput": { @@ -21285,7 +21290,7 @@ "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.

\n " } }, "ProvisionedThroughput": { @@ -21333,7 +21338,7 @@ "MultiRegionConsistency": { "target": "com.amazonaws.dynamodb#MultiRegionConsistency", "traits": { - "smithy.api#documentation": "

Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

\n

You can specify one of the following consistency modes:

\n \n

If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

" + "smithy.api#documentation": "

Specifies the consistency mode for a new global table. This parameter is only valid\n when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

\n

You can specify one of the following consistency modes:

\n \n

If you don't specify this parameter, the global table consistency mode defaults to\n EVENTUAL.

" } }, "OnDemandThroughput": { @@ -21345,7 +21350,7 @@ "WarmThroughput": { "target": "com.amazonaws.dynamodb#WarmThroughput", "traits": { - "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second) for updating a table.

" + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second)\n for updating a table.

" } } }, diff --git a/ec2/service/2016-11-15/ec2-2016-11-15.json b/ec2/service/2016-11-15/ec2-2016-11-15.json index 1e3d0deb..2ac6e977 100644 --- a/ec2/service/2016-11-15/ec2-2016-11-15.json +++ b/ec2/service/2016-11-15/ec2-2016-11-15.json @@ -2347,6 +2347,9 @@ { "target": "com.amazonaws.ec2#AssociateNatGatewayAddress" }, + { + "target": "com.amazonaws.ec2#AssociateRouteServer" + }, { "target": "com.amazonaws.ec2#AssociateRouteTable" }, @@ -2587,6 +2590,15 @@ { "target": "com.amazonaws.ec2#CreateRoute" }, + { + "target": "com.amazonaws.ec2#CreateRouteServer" + }, + { + "target": "com.amazonaws.ec2#CreateRouteServerEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateRouteServerPeer" + }, { "target": "com.amazonaws.ec2#CreateRouteTable" }, @@ -2821,6 +2833,15 @@ { "target": "com.amazonaws.ec2#DeleteRoute" }, + { + "target": "com.amazonaws.ec2#DeleteRouteServer" + }, + { + "target": "com.amazonaws.ec2#DeleteRouteServerEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteRouteServerPeer" + }, { "target": "com.amazonaws.ec2#DeleteRouteTable" }, @@ -3256,6 +3277,15 @@ { "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferings" }, + { + "target": "com.amazonaws.ec2#DescribeRouteServerEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeRouteServerPeers" + }, + { + "target": "com.amazonaws.ec2#DescribeRouteServers" + }, { "target": "com.amazonaws.ec2#DescribeRouteTables" }, @@ -3487,6 +3517,9 @@ { "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" }, + { + "target": "com.amazonaws.ec2#DisableRouteServerPropagation" + }, { "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" }, @@ -3532,6 +3565,9 @@ { "target": "com.amazonaws.ec2#DisassociateNatGatewayAddress" }, + { + "target": "com.amazonaws.ec2#DisassociateRouteServer" + }, { "target": "com.amazonaws.ec2#DisassociateRouteTable" }, @@ -3592,6 +3628,9 @@ { "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing" }, + { + "target": "com.amazonaws.ec2#EnableRouteServerPropagation" + }, { "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" }, @@ -3730,6 +3769,15 @@ { "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuote" }, + { + "target": "com.amazonaws.ec2#GetRouteServerAssociations" + }, + { + "target": "com.amazonaws.ec2#GetRouteServerPropagations" + }, + { + "target": "com.amazonaws.ec2#GetRouteServerRoutingDatabase" + }, { "target": "com.amazonaws.ec2#GetSecurityGroupsForVpc" }, @@ -3916,6 +3964,9 @@ { "target": "com.amazonaws.ec2#ModifyReservedInstances" }, + { + "target": "com.amazonaws.ec2#ModifyRouteServer" + }, { "target": "com.amazonaws.ec2#ModifySecurityGroupRules" }, @@ -5957,6 +6008,15 @@ } } }, + "com.amazonaws.ec2#AsPath": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#AsnAssociation": { "type": "structure", "members": { @@ -7142,6 +7202,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#AssociateRouteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateRouteServerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateRouteServerResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a route server with a VPC to enable dynamic route updates.

\n

A route server association is the connection established between a route server and a VPC.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateRouteServerRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the route server to be associated.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to associate with the route server.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateRouteServerResult": { + "type": "structure", + "members": { + "RouteServerAssociation": { + "target": "com.amazonaws.ec2#RouteServerAssociation", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerAssociation", + "smithy.api#documentation": "

Information about the association between the route server and the VPC.

", + "smithy.api#xmlName": "routeServerAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#AssociateRouteTable": { "type": "operation", "input": { @@ -9791,6 +9909,9 @@ "com.amazonaws.ec2#BoxedInteger": { "type": "integer" }, + "com.amazonaws.ec2#BoxedLong": { + "type": "long" + }, "com.amazonaws.ec2#BundleId": { "type": "string" }, @@ -13037,6 +13158,36 @@ "smithy.api#documentation": "

Current state of options for customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" } }, + "com.amazonaws.ec2#ClientRouteEnforcementOptions": { + "type": "structure", + "members": { + "Enforced": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Enable or disable the client route enforcement feature.

\n

Valid values: true | false\n

\n

Default value: false\n

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

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\n\t\this feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

\n

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, \n\t\t\treverting it back to the expected route configurations.

" + } + }, + "com.amazonaws.ec2#ClientRouteEnforcementResponseOptions": { + "type": "structure", + "members": { + "Enforced": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enforced", + "smithy.api#documentation": "

Status of the client route enforcement feature.

\n

Valid values: true | false\n

\n

Default value: false\n

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

The current status of client route enforcement. The state will either be true (enabled) or false (disabled).

" + } + }, "com.amazonaws.ec2#ClientSecretType": { "type": "string", "traits": { @@ -13578,6 +13729,14 @@ "smithy.api#xmlName": "clientLoginBannerOptions" } }, + "ClientRouteEnforcementOptions": { + "target": "com.amazonaws.ec2#ClientRouteEnforcementResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ClientRouteEnforcementOptions", + "smithy.api#documentation": "

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\n\t\this feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

\n

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, \n\t\t\treverting it back to the expected route configurations.

", + "smithy.api#xmlName": "clientRouteEnforcementOptions" + } + }, "DisconnectOnSessionTimeout": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -14694,7 +14853,8 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For\n more information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For\n more information, see Ensuring idempotency\n in the Amazon EC2 API Reference.

", + "smithy.api#idempotencyToken": {} } }, "Description": { @@ -15721,6 +15881,12 @@ "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" } }, + "ClientRouteEnforcementOptions": { + "target": "com.amazonaws.ec2#ClientRouteEnforcementOptions", + "traits": { + "smithy.api#documentation": "

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\n\t\this feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

\n

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, \n\t\t\treverting it back to the expected route configurations.

" + } + }, "DisconnectOnSessionTimeout": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -19458,7 +19624,7 @@ "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by\n using CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by\n using CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { @@ -19489,7 +19655,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.

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

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.

\n ", "smithy.api#xmlName": "TagSpecification" } }, @@ -19685,6 +19851,233 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#CreateRouteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteServerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteServerResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new route server to manage dynamic routing in a VPC.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRouteServerEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteServerEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteServerEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new endpoint for a route server in a specified subnet.

\n

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRouteServerEndpointRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to create an endpoint.

", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet in which to create the route server endpoint.

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

Unique, case-sensitive identifier to ensure idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making 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 apply to the route server endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteServerEndpointResult": { + "type": "structure", + "members": { + "RouteServerEndpoint": { + "target": "com.amazonaws.ec2#RouteServerEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpoint", + "smithy.api#documentation": "

Information about the created route server endpoint.

", + "smithy.api#xmlName": "routeServerEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRouteServerPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteServerPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteServerPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new BGP peer for a specified route server endpoint.

\n

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

\n \n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRouteServerPeerRequest": { + "type": "structure", + "members": { + "RouteServerEndpointId": { + "target": "com.amazonaws.ec2#RouteServerEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server endpoint for which to create a peer.

", + "smithy.api#required": {} + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address of the peer device.

", + "smithy.api#required": {} + } + }, + "BgpOptions": { + "target": "com.amazonaws.ec2#RouteServerBgpOptionsRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making 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 apply to the route server peer during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteServerPeerResult": { + "type": "structure", + "members": { + "RouteServerPeer": { + "target": "com.amazonaws.ec2#RouteServerPeer", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPeer", + "smithy.api#documentation": "

Information about the created route server peer.

", + "smithy.api#xmlName": "routeServerPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRouteServerRequest": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.

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

Unique, case-sensitive identifier to ensure idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PersistRoutes": { + "target": "com.amazonaws.ec2#RouteServerPersistRoutesAction", + "traits": { + "smithy.api#documentation": "

Indicates whether routes should be persisted after all BGP sessions are terminated.

" + } + }, + "PersistRoutesDuration": { + "target": "com.amazonaws.ec2#BoxedLong", + "traits": { + "smithy.api#documentation": "

The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled.

\n

If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

" + } + }, + "SnsNotificationsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the route server during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteServerResult": { + "type": "structure", + "members": { + "RouteServer": { + "target": "com.amazonaws.ec2#RouteServer", + "traits": { + "aws.protocols#ec2QueryName": "RouteServer", + "smithy.api#documentation": "

Information about the created route server.

", + "smithy.api#xmlName": "routeServer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateRouteTable": { "type": "operation", "input": { @@ -20143,7 +20536,7 @@ "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateStoreImageTaskRequest": { @@ -26524,6 +26917,156 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#DeleteRouteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteServerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteRouteServerResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route server.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteRouteServerEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteServerEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteRouteServerEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route server endpoint.

\n

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

" + } + }, + "com.amazonaws.ec2#DeleteRouteServerEndpointRequest": { + "type": "structure", + "members": { + "RouteServerEndpointId": { + "target": "com.amazonaws.ec2#RouteServerEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server endpoint to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteRouteServerEndpointResult": { + "type": "structure", + "members": { + "RouteServerEndpoint": { + "target": "com.amazonaws.ec2#RouteServerEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpoint", + "smithy.api#documentation": "

Information about the deleted route server endpoint.

", + "smithy.api#xmlName": "routeServerEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteRouteServerPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteServerPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteRouteServerPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified BGP peer from a route server.

\n

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

\n " + } + }, + "com.amazonaws.ec2#DeleteRouteServerPeerRequest": { + "type": "structure", + "members": { + "RouteServerPeerId": { + "target": "com.amazonaws.ec2#RouteServerPeerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server peer to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteRouteServerPeerResult": { + "type": "structure", + "members": { + "RouteServerPeer": { + "target": "com.amazonaws.ec2#RouteServerPeer", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPeer", + "smithy.api#documentation": "

Information about the deleted route server peer.

", + "smithy.api#xmlName": "routeServerPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteRouteServerRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteRouteServerResult": { + "type": "structure", + "members": { + "RouteServer": { + "target": "com.amazonaws.ec2#RouteServer", + "traits": { + "aws.protocols#ec2QueryName": "RouteServer", + "smithy.api#documentation": "

Information about the deleted route server.

", + "smithy.api#xmlName": "routeServer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeleteRouteTable": { "type": "operation", "input": { @@ -28585,7 +29128,7 @@ "target": "com.amazonaws.ec2#DeregisterImageResult" }, "traits": { - "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new\n instances.

\n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in\n the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

\n

When you deregister an AMI, it doesn't affect any instances that you've already launched\n from the AMI. You'll continue to incur usage costs for those instances until you terminate\n them.

\n

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created\n for the root volume of the instance during the AMI creation process. When you deregister an\n instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you\n created the AMI.

" + "smithy.api#documentation": "

Deregisters the specified AMI. A deregistered AMI can't be used to launch new\n instances.

\n

If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the\n Recycle Bin for the specified retention period. It can be restored before its retention period\n expires, after which it is permanently deleted. If the deregistered AMI doesn't match a\n retention rule, it is permanently deleted immediately. For more information, see Recycle Bin in\n the Amazon EBS User Guide.

\n

Deregistering an AMI does not delete the following:

\n \n

For more information, see Deregister an Amazon EC2 AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -34021,7 +34564,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -34481,7 +35024,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

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

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -38913,6 +39456,252 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeRouteServerEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRouteServerEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRouteServerEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more route server endpoints.

\n

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteServerEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeRouteServerEndpointsRequest": { + "type": "structure", + "members": { + "RouteServerEndpointIds": { + "target": "com.amazonaws.ec2#RouteServerEndpointIdsList", + "traits": { + "smithy.api#documentation": "

The IDs of the route server endpoints to describe.

", + "smithy.api#xmlName": "RouteServerEndpointId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#RouteServerMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters to apply to the describe request.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRouteServerEndpointsResult": { + "type": "structure", + "members": { + "RouteServerEndpoints": { + "target": "com.amazonaws.ec2#RouteServerEndpointsList", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpointSet", + "smithy.api#documentation": "

Information about the described route server endpoints.

", + "smithy.api#xmlName": "routeServerEndpointSet" + } + }, + "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" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRouteServerPeers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRouteServerPeersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRouteServerPeersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more route server peers.

\n

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

\n \n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteServerPeers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeRouteServerPeersRequest": { + "type": "structure", + "members": { + "RouteServerPeerIds": { + "target": "com.amazonaws.ec2#RouteServerPeerIdsList", + "traits": { + "smithy.api#documentation": "

The IDs of the route server peers to describe.

", + "smithy.api#xmlName": "RouteServerPeerId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#RouteServerMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters to apply to the describe request.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRouteServerPeersResult": { + "type": "structure", + "members": { + "RouteServerPeers": { + "target": "com.amazonaws.ec2#RouteServerPeersList", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPeerSet", + "smithy.api#documentation": "

Information about the described route server peers.

", + "smithy.api#xmlName": "routeServerPeerSet" + } + }, + "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" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRouteServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRouteServersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRouteServersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more route servers.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteServers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeRouteServersRequest": { + "type": "structure", + "members": { + "RouteServerIds": { + "target": "com.amazonaws.ec2#RouteServerIdsList", + "traits": { + "smithy.api#documentation": "

The IDs of the route servers to describe.

", + "smithy.api#xmlName": "RouteServerId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#RouteServerMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters to apply to the describe request.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRouteServersResult": { + "type": "structure", + "members": { + "RouteServers": { + "target": "com.amazonaws.ec2#RouteServersList", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerSet", + "smithy.api#documentation": "

Information about the described route servers.

", + "smithy.api#xmlName": "routeServerSet" + } + }, + "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" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DescribeRouteTables": { "type": "operation", "input": { @@ -40959,7 +41748,7 @@ "target": "com.amazonaws.ec2#DescribeStoreImageTasksResult" }, "traits": { - "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

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

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n Amazon S3 in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -41024,7 +41813,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n \n \n

When you specify the ImageIds parameter, any filters that you specify are\n ignored. To use the filters, you must remove the ImageIds parameter.

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

The filters.

\n \n \n

When you specify the ImageIds parameter, any filters that you specify are\n ignored. To use the filters, you must remove the ImageIds parameter.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -44292,7 +45081,7 @@ "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. Principal ARNs with path components aren't supported.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -45722,7 +46511,7 @@ "target": "com.amazonaws.ec2#DisableAllowedImagesSettingsResult" }, "traits": { - "smithy.api#documentation": "

Disables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to\n disabled, the image criteria in your Allowed AMIs settings do not apply, and no\n restrictions are placed on AMI discoverability or usage. Users in your account can launch\n instances using any public AMI or AMI shared with your account.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Disables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to\n disabled, the image criteria in your Allowed AMIs settings do not apply, and no\n restrictions are placed on AMI discoverability or usage. Users in your account can launch\n instances using any public AMI or AMI shared with your account.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableAllowedImagesSettingsRequest": { @@ -46255,7 +47044,7 @@ "target": "com.amazonaws.ec2#DisableImageResult" }, "traits": { - "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If an AMI was public or previously shared, it is made\n private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit,\n they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If an AMI was public or previously shared, it is made\n private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit,\n they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageBlockPublicAccess": { @@ -46267,7 +47056,7 @@ "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" }, "traits": { - "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { @@ -46309,7 +47098,7 @@ "target": "com.amazonaws.ec2#DisableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageDeprecationRequest": { @@ -46359,7 +47148,7 @@ "target": "com.amazonaws.ec2#DisableImageDeregistrationProtectionResult" }, "traits": { - "smithy.api#documentation": "

Disables deregistration protection for an AMI. When deregistration protection is disabled,\n the AMI can be deregistered.

\n

If you chose to include a 24-hour cooldown period when you enabled deregistration\n protection for the AMI, then, when you disable deregistration protection, you won\u2019t\n immediately be able to deregister the AMI.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Disables deregistration protection for an AMI. When deregistration protection is disabled,\n the AMI can be deregistered.

\n

If you chose to include a 24-hour cooldown period when you enabled deregistration\n protection for the AMI, then, when you disable deregistration protection, you won\u2019t\n immediately be able to deregister the AMI.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageDeregistrationProtectionRequest": { @@ -46488,6 +47277,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableRouteServerPropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableRouteServerPropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableRouteServerPropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Disables route propagation from a route server to a specified route table.

\n

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DisableRouteServerPropagationRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to disable propagation.

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table for which to disable route server propagation.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableRouteServerPropagationResult": { + "type": "structure", + "members": { + "RouteServerPropagation": { + "target": "com.amazonaws.ec2#RouteServerPropagation", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPropagation", + "smithy.api#documentation": "

Information about the disabled route server propagation.

", + "smithy.api#xmlName": "routeServerPropagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisableSerialConsoleAccess": { "type": "operation", "input": { @@ -47318,6 +48165,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisassociateRouteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateRouteServerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateRouteServerResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a route server from a VPC.

\n

A route server association is the connection established between a route server and a VPC.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#DisassociateRouteServerRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server to disassociate.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to disassociate from the route server.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateRouteServerResult": { + "type": "structure", + "members": { + "RouteServerAssociation": { + "target": "com.amazonaws.ec2#RouteServerAssociation", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerAssociation", + "smithy.api#documentation": "

Information about the disassociated route server.

", + "smithy.api#xmlName": "routeServerAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisassociateRouteTable": { "type": "operation", "input": { @@ -49342,13 +50247,13 @@ "EnaSrdEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether ENA Express is enabled for the network interface when you \n\t\t\tlaunch an instance from your launch template.

" + "smithy.api#documentation": "

Specifies whether ENA Express is enabled for the network interface when you \n\t\t\tlaunch an instance.

" } }, "EnaSrdUdpSpecification": { "target": "com.amazonaws.ec2#EnaSrdUdpSpecificationRequest", "traits": { - "smithy.api#documentation": "

Contains ENA Express settings for UDP network traffic in your launch template.

" + "smithy.api#documentation": "

Contains ENA Express settings for UDP network traffic for the network interface \n\t attached to the instance.

" } } }, @@ -49379,7 +50284,7 @@ "EnaSrdUdpEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether UDP traffic uses ENA Express for your instance. To ensure that \n\t\t\tUDP traffic can use ENA Express when you launch an instance, you must also set \n\t\t\tEnaSrdEnabled in the EnaSrdSpecificationRequest to true in your \n\t\t\tlaunch template.

" + "smithy.api#documentation": "

Indicates whether UDP traffic uses ENA Express for your instance. To ensure that \n\t\t\tUDP traffic can use ENA Express when you launch an instance, you must also set \n\t\t\tEnaSrdEnabled in the EnaSrdSpecificationRequest to true.

" } } }, @@ -49477,7 +50382,7 @@ "target": "com.amazonaws.ec2#EnableAllowedImagesSettingsResult" }, "traits": { - "smithy.api#documentation": "

Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are\n accepted:

\n \n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are\n accepted:

\n \n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableAllowedImagesSettingsRequest": { @@ -50036,7 +50941,7 @@ "target": "com.amazonaws.ec2#EnableImageResult" }, "traits": { - "smithy.api#documentation": "

Re-enables a disabled AMI. The re-enabled AMI is marked as available and can\n be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services\n accounts, organizations, and Organizational Units that lost access to the AMI when it was\n disabled do not regain access automatically. Once the AMI is available, it can be shared with\n them again.

\n

Only the AMI owner can re-enable a disabled AMI.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Re-enables a disabled AMI. The re-enabled AMI is marked as available and can\n be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services\n accounts, organizations, and Organizational Units that lost access to the AMI when it was\n disabled do not regain access automatically. Once the AMI is available, it can be shared with\n them again.

\n

Only the AMI owner can re-enable a disabled AMI.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageBlockPublicAccess": { @@ -50048,7 +50953,7 @@ "target": "com.amazonaws.ec2#EnableImageBlockPublicAccessResult" }, "traits": { - "smithy.api#documentation": "

Enables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already\n have public AMIs, they will remain publicly available.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be unblocked. When\n the API has completed the configuration, the response will be\n block-new-sharing.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already\n have public AMIs, they will remain publicly available.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be unblocked. When\n the API has completed the configuration, the response will be\n block-new-sharing.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageBlockPublicAccessRequest": { @@ -50098,7 +51003,7 @@ "target": "com.amazonaws.ec2#EnableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageDeprecationRequest": { @@ -50116,7 +51021,7 @@ "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

\n

You can\u2019t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation\n date.

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

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

\n

You can\u2019t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation\n date.

", "smithy.api#required": {} } }, @@ -50156,7 +51061,7 @@ "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult" }, "traits": { - "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.

\n

For more information, see Protect an\n AMI from deregistration in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest": { @@ -50333,6 +51238,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#EnableRouteServerPropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableRouteServerPropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableRouteServerPropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Defines which route tables the route server can update with routes.

\n

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#EnableRouteServerPropagationRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to enable propagation.

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table to which route server will propagate routes.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableRouteServerPropagationResult": { + "type": "structure", + "members": { + "RouteServerPropagation": { + "target": "com.amazonaws.ec2#RouteServerPropagation", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPropagation", + "smithy.api#documentation": "

Information about the enabled route server propagation.

", + "smithy.api#xmlName": "routeServerPropagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#EnableSerialConsoleAccess": { "type": "operation", "input": { @@ -52249,7 +53212,7 @@ } }, "traits": { - "smithy.api#documentation": "

Request to create a launch template for a Windows fast launch enabled AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

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

Request to create a launch template for a Windows fast launch enabled AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

\n " } }, "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse": { @@ -54296,7 +55259,7 @@ "target": "com.amazonaws.ec2#GetAllowedImagesSettingsResult" }, "traits": { - "smithy.api#documentation": "

Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria\n at the account level in the specified Region.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria\n at the account level in the specified Region.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetAllowedImagesSettingsRequest": { @@ -55415,7 +56378,7 @@ "target": "com.amazonaws.ec2#GetImageBlockPublicAccessStateResult" }, "traits": { - "smithy.api#documentation": "

Gets the current state of block public access for AMIs at the account\n level in the specified Amazon Web Services Region.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Gets the current state of block public access for AMIs at the account\n level in the specified Amazon Web Services Region.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetImageBlockPublicAccessStateRequest": { @@ -57049,6 +58012,197 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#GetRouteServerAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetRouteServerAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetRouteServerAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the associations for the specified route server.

\n

A route server association is the connection established between a route server and a VPC.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#GetRouteServerAssociationsRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to get association information.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetRouteServerAssociationsResult": { + "type": "structure", + "members": { + "RouteServerAssociations": { + "target": "com.amazonaws.ec2#RouteServerAssociationsList", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerAssociationSet", + "smithy.api#documentation": "

Information about the associations for the specified route server.

", + "smithy.api#xmlName": "routeServerAssociationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetRouteServerPropagations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetRouteServerPropagationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetRouteServerPropagationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the route propagations for the specified route server.

\n

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

" + } + }, + "com.amazonaws.ec2#GetRouteServerPropagationsRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to get propagation information.

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

The ID of the route table for which to get propagation information.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetRouteServerPropagationsResult": { + "type": "structure", + "members": { + "RouteServerPropagations": { + "target": "com.amazonaws.ec2#RouteServerPropagationsList", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPropagationSet", + "smithy.api#documentation": "

Information about the route propagations for the specified route server.

", + "smithy.api#xmlName": "routeServerPropagationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetRouteServerRoutingDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetRouteServerRoutingDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetRouteServerRoutingDatabaseResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the routing database for the specified route server. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

" + } + }, + "com.amazonaws.ec2#GetRouteServerRoutingDatabaseRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server for which to get the routing database.

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

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#RouteServerMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of routing database entries to return in a single response.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making 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": "

Filters to apply to the routing database query.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetRouteServerRoutingDatabaseResult": { + "type": "structure", + "members": { + "AreRoutesPersisted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AreRoutesPersisted", + "smithy.api#documentation": "

Indicates whether routes are being persisted in the routing database.

", + "smithy.api#xmlName": "areRoutesPersisted" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#RouteServerRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

The collection of routes in the route server's routing database.

", + "smithy.api#xmlName": "routeSet" + } + }, + "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" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#GetSecurityGroupsForVpc": { "type": "operation", "input": { @@ -59760,7 +60914,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "ImageAllowed", - "smithy.api#documentation": "

If true, the AMI satisfies the criteria for Allowed AMIs and can be\n discovered and used in the account. If false and Allowed AMIs is set to\n enabled, the AMI can't be discovered or used in the account. If\n false and Allowed AMIs is set to audit-mode, the AMI can be\n discovered and used in the account.

\n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

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

If true, the AMI satisfies the criteria for Allowed AMIs and can be\n discovered and used in the account. If false and Allowed AMIs is set to\n enabled, the AMI can't be discovered or used in the account. If\n false and Allowed AMIs is set to audit-mode, the AMI can be\n discovered and used in the account.

\n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "imageAllowed" } }, @@ -60119,7 +61273,7 @@ } }, "traits": { - "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ImageCriterionList": { @@ -60143,7 +61297,7 @@ } }, "traits": { - "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ImageCriterionRequestList": { @@ -60277,7 +61431,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ImageOwnerAlias", - "smithy.api#documentation": "

The alias of the AMI owner.

\n

Valid values: amazon | aws-backup-vault |\n aws-marketplace\n

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

The alias of the AMI owner.

\n

Valid values: amazon | aws-backup-vault |\n aws-marketplace\n

", "smithy.api#xmlName": "imageOwnerAlias" } }, @@ -60293,7 +61447,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DeprecationTime", - "smithy.api#documentation": "

The deprecation date and time of the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.

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

The deprecation date and time of the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.

", "smithy.api#xmlName": "deprecationTime" } }, @@ -76338,7 +77492,7 @@ "DeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The device index for the network interface attachment. Each network interface requires\n a device index. If you create a launch template that includes secondary network interfaces \n but not a primary network interface, then you must add a primary network interface as a \n launch parameter when you launch an instance from the template.

" + "smithy.api#documentation": "

The device index for the network interface attachment. The primary network interface\n has a device index of 0. Each network interface is of type interface, you\n must specify a device index. If you create a launch template that includes secondary \n network interfaces but not a primary network interface, then you must add a primary \n network interface as a launch parameter when you launch an instance from the template.

" } }, "Groups": { @@ -77190,7 +78344,7 @@ "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" }, "traits": { - "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see\n Recycle\n Bin in the Amazon EC2 User Guide.

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

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see\n Recycle\n Bin in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -79548,6 +80702,12 @@ "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" } }, + "ClientRouteEnforcementOptions": { + "target": "com.amazonaws.ec2#ClientRouteEnforcementOptions", + "traits": { + "smithy.api#documentation": "

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\n\t\this feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

\n

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, \n\t\t\treverting it back to the expected route configurations.

" + } + }, "DisconnectOnSessionTimeout": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -80244,7 +81404,7 @@ "target": "com.amazonaws.ec2#InstanceAttributeName", "traits": { "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

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

The name of the attribute to modify.

\n \n

When changing the instance type: If the original instance type is configured for\n configurable bandwidth, and the desired instance type doesn't support configurable\n bandwidth, first set the existing bandwidth configuration to default\n using the ModifyInstanceNetworkPerformanceOptions\n operation.

\n \n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", "smithy.api#xmlName": "attribute" } }, @@ -81990,6 +83150,74 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#ModifyRouteServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyRouteServerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyRouteServerResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of an existing route server.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

\n

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyRouteServerRequest": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route server to modify.

", + "smithy.api#required": {} + } + }, + "PersistRoutes": { + "target": "com.amazonaws.ec2#RouteServerPersistRoutesAction", + "traits": { + "smithy.api#documentation": "

Specifies whether to persist routes after all BGP sessions are terminated.

\n " + } + }, + "PersistRoutesDuration": { + "target": "com.amazonaws.ec2#BoxedLong", + "traits": { + "smithy.api#documentation": "

The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled.

\n

If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

" + } + }, + "SnsNotificationsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyRouteServerResult": { + "type": "structure", + "members": { + "RouteServer": { + "target": "com.amazonaws.ec2#RouteServer", + "traits": { + "aws.protocols#ec2QueryName": "RouteServer", + "smithy.api#documentation": "

Information about the modified route server.

", + "smithy.api#xmlName": "routeServer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#ModifySecurityGroupRules": { "type": "operation", "input": { @@ -84503,7 +85731,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions\n for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to\n your endpoint service.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions\n for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to\n your endpoint service. Principal ARNs with path components aren't supported.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { @@ -92922,7 +94150,7 @@ "target": "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsResult" }, "traits": { - "smithy.api#documentation": "

Sets or replaces the criteria for Allowed AMIs.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Sets or replaces the criteria for Allowed AMIs.

\n \n

The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of\n the criteria you set, the AMIs created by your account will always be discoverable and\n usable by users in your account.

\n \n

For more information, see Control the discovery and use of AMIs in\n Amazon EC2 with Allowed AMIs in\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ReplaceImageCriteriaInAllowedImagesSettingsRequest": { @@ -96598,6 +97826,24 @@ "smithy.api#enumValue": "vpc-block-public-access-exclusion" } }, + "route_server": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "route-server" + } + }, + "route_server_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "route-server-endpoint" + } + }, + "route_server_peer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "route-server-peer" + } + }, "ipam_resource_discovery": { "target": "smithy.api#Unit", "traits": { @@ -97997,6 +99243,941 @@ } } }, + "com.amazonaws.ec2#RouteServer": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerId", + "smithy.api#documentation": "

The unique identifier of the route server.

", + "smithy.api#xmlName": "routeServerId" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteServerState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the route server.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route server.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PersistRoutesState": { + "target": "com.amazonaws.ec2#RouteServerPersistRoutesState", + "traits": { + "aws.protocols#ec2QueryName": "PersistRoutesState", + "smithy.api#documentation": "

The current state of route persistence for the route server.

", + "smithy.api#xmlName": "persistRoutesState" + } + }, + "PersistRoutesDuration": { + "target": "com.amazonaws.ec2#BoxedLong", + "traits": { + "aws.protocols#ec2QueryName": "PersistRoutesDuration", + "smithy.api#documentation": "

The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.

\n

If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

", + "smithy.api#xmlName": "persistRoutesDuration" + } + }, + "SnsNotificationsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SnsNotificationsEnabled", + "smithy.api#documentation": "

Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

", + "smithy.api#xmlName": "snsNotificationsEnabled" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnsTopicArn", + "smithy.api#documentation": "

The ARN of the SNS topic where notifications are published.

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

Describes a route server and its configuration.

\n

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, \nVPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

\n

Route server supports the follow route table types:

\n \n

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

" + } + }, + "com.amazonaws.ec2#RouteServerAssociation": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerId", + "smithy.api#documentation": "

The ID of the associated route server.

", + "smithy.api#xmlName": "routeServerId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the associated VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteServerAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the association.

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

Describes the association between a route server and a VPC.

\n

A route server association is the connection established between a route server and a VPC.

" + } + }, + "com.amazonaws.ec2#RouteServerAssociationState": { + "type": "enum", + "members": { + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "DISASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + } + } + }, + "com.amazonaws.ec2#RouteServerAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerBfdState": { + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "up" + } + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "down" + } + } + } + }, + "com.amazonaws.ec2#RouteServerBfdStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#RouteServerBfdState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The operational status of the BFD session.

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

The current status of Bidirectional Forwarding Detection (BFD) for a BGP session.

" + } + }, + "com.amazonaws.ec2#RouteServerBgpOptions": { + "type": "structure", + "members": { + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "PeerAsn", + "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.

", + "smithy.api#xmlName": "peerAsn" + } + }, + "PeerLivenessDetection": { + "target": "com.amazonaws.ec2#RouteServerPeerLivenessMode", + "traits": { + "aws.protocols#ec2QueryName": "PeerLivenessDetection", + "smithy.api#documentation": "

The liveness detection protocol used for the BGP peer.

\n

The requested liveness detection protocol for the BGP peer.

\n \n

Defaults to bgp-keepalive.

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

The BGP configuration options for a route server peer.

" + } + }, + "com.amazonaws.ec2#RouteServerBgpOptionsRequest": { + "type": "structure", + "members": { + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512\u201365534 (16-bit ASN) or 4200000000\u20134294967294 (32-bit ASN) range.

", + "smithy.api#required": {} + } + }, + "PeerLivenessDetection": { + "target": "com.amazonaws.ec2#RouteServerPeerLivenessMode", + "traits": { + "smithy.api#documentation": "

The requested liveness detection protocol for the BGP peer.

\n \n

Defaults to bgp-keepalive.

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

The BGP configuration options requested for a route server peer.

" + } + }, + "com.amazonaws.ec2#RouteServerBgpState": { + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "up" + } + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "down" + } + } + } + }, + "com.amazonaws.ec2#RouteServerBgpStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#RouteServerBgpState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.

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

The current status of a BGP session.

" + } + }, + "com.amazonaws.ec2#RouteServerEndpoint": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerId", + "smithy.api#documentation": "

The ID of the route server associated with this endpoint.

", + "smithy.api#xmlName": "routeServerId" + } + }, + "RouteServerEndpointId": { + "target": "com.amazonaws.ec2#RouteServerEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpointId", + "smithy.api#documentation": "

The unique identifier of the route server endpoint.

", + "smithy.api#xmlName": "routeServerEndpointId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC containing the endpoint.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet to place the route server endpoint into.

", + "smithy.api#xmlName": "subnetId" + } + }, + "EniId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "EniId", + "smithy.api#documentation": "

The ID of the Elastic network interface for the endpoint.

", + "smithy.api#xmlName": "eniId" + } + }, + "EniAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EniAddress", + "smithy.api#documentation": "

The IP address of the Elastic network interface for the endpoint.

", + "smithy.api#xmlName": "eniAddress" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteServerEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the route server endpoint.

", + "smithy.api#xmlName": "state" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

The reason for any failure in endpoint creation or operation.

", + "smithy.api#xmlName": "failureReason" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route server endpoint.

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

Describes a route server endpoint and its properties.

\n

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

" + } + }, + "com.amazonaws.ec2#RouteServerEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteServerEndpointIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerEndpointId" + } + }, + "com.amazonaws.ec2#RouteServerEndpointState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "FAILING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#RouteServerEndpointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteServerIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerId" + } + }, + "com.amazonaws.ec2#RouteServerMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#RouteServerPeer": { + "type": "structure", + "members": { + "RouteServerPeerId": { + "target": "com.amazonaws.ec2#RouteServerPeerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPeerId", + "smithy.api#documentation": "

The unique identifier of the route server peer.

", + "smithy.api#xmlName": "routeServerPeerId" + } + }, + "RouteServerEndpointId": { + "target": "com.amazonaws.ec2#RouteServerEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpointId", + "smithy.api#documentation": "

The ID of the route server endpoint associated with this peer.

", + "smithy.api#xmlName": "routeServerEndpointId" + } + }, + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerId", + "smithy.api#documentation": "

The ID of the route server associated with this peer.

", + "smithy.api#xmlName": "routeServerId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC containing the route server peer.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet containing the route server peer.

", + "smithy.api#xmlName": "subnetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteServerPeerState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the route server peer.

", + "smithy.api#xmlName": "state" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

The reason for any failure in peer creation or operation.

", + "smithy.api#xmlName": "failureReason" + } + }, + "EndpointEniId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "EndpointEniId", + "smithy.api#documentation": "

The ID of the Elastic network interface for the route server endpoint.

", + "smithy.api#xmlName": "endpointEniId" + } + }, + "EndpointEniAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EndpointEniAddress", + "smithy.api#documentation": "

The IP address of the Elastic network interface for the route server endpoint.

", + "smithy.api#xmlName": "endpointEniAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The IPv4 address of the peer device.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "BgpOptions": { + "target": "com.amazonaws.ec2#RouteServerBgpOptions", + "traits": { + "aws.protocols#ec2QueryName": "BgpOptions", + "smithy.api#documentation": "

The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

", + "smithy.api#xmlName": "bgpOptions" + } + }, + "BgpStatus": { + "target": "com.amazonaws.ec2#RouteServerBgpStatus", + "traits": { + "aws.protocols#ec2QueryName": "BgpStatus", + "smithy.api#documentation": "

The current status of the BGP session with this peer.

", + "smithy.api#xmlName": "bgpStatus" + } + }, + "BfdStatus": { + "target": "com.amazonaws.ec2#RouteServerBfdStatus", + "traits": { + "aws.protocols#ec2QueryName": "BfdStatus", + "smithy.api#documentation": "

The current status of the BFD session with this peer.

", + "smithy.api#xmlName": "bfdStatus" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route server peer.

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

Describes a BGP peer configuration for a route server endpoint.

\n

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

\n " + } + }, + "com.amazonaws.ec2#RouteServerPeerId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteServerPeerIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerPeerId" + } + }, + "com.amazonaws.ec2#RouteServerPeerLivenessMode": { + "type": "enum", + "members": { + "BFD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bfd" + } + }, + "BGP_KEEPALIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bgp-keepalive" + } + } + } + }, + "com.amazonaws.ec2#RouteServerPeerState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "FAILING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#RouteServerPeersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerPeer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerPersistRoutesAction": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + }, + "RESET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reset" + } + } + } + }, + "com.amazonaws.ec2#RouteServerPersistRoutesState": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "RESETTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resetting" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + } + } + }, + "com.amazonaws.ec2#RouteServerPropagation": { + "type": "structure", + "members": { + "RouteServerId": { + "target": "com.amazonaws.ec2#RouteServerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerId", + "smithy.api#documentation": "

The ID of the route server configured for route propagation.

", + "smithy.api#xmlName": "routeServerId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table configured for route server propagation.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteServerPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of route propagation.

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

Describes the route propagation configuration between a route server and a route table.

\n

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

" + } + }, + "com.amazonaws.ec2#RouteServerPropagationState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#RouteServerPropagationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerPropagation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerRoute": { + "type": "structure", + "members": { + "RouteServerEndpointId": { + "target": "com.amazonaws.ec2#RouteServerEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerEndpointId", + "smithy.api#documentation": "

The ID of the route server endpoint that received this route.

", + "smithy.api#xmlName": "routeServerEndpointId" + } + }, + "RouteServerPeerId": { + "target": "com.amazonaws.ec2#RouteServerPeerId", + "traits": { + "aws.protocols#ec2QueryName": "RouteServerPeerId", + "smithy.api#documentation": "

The ID of the route server peer that advertised this route.

", + "smithy.api#xmlName": "routeServerPeerId" + } + }, + "RouteInstallationDetails": { + "target": "com.amazonaws.ec2#RouteServerRouteInstallationDetails", + "traits": { + "aws.protocols#ec2QueryName": "RouteInstallationDetailSet", + "smithy.api#documentation": "

Details about the installation status of this route in route tables.

", + "smithy.api#xmlName": "routeInstallationDetailSet" + } + }, + "RouteStatus": { + "target": "com.amazonaws.ec2#RouteServerRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "RouteStatus", + "smithy.api#documentation": "

The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

\n

The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

\n

The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

", + "smithy.api#xmlName": "routeStatus" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The destination CIDR block of the route.

", + "smithy.api#xmlName": "prefix" + } + }, + "AsPaths": { + "target": "com.amazonaws.ec2#AsPath", + "traits": { + "aws.protocols#ec2QueryName": "AsPathSet", + "smithy.api#documentation": "

The AS path attributes of the BGP route.

", + "smithy.api#xmlName": "asPathSet" + } + }, + "Med": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Med", + "smithy.api#documentation": "

The Multi-Exit Discriminator (MED) value of the BGP route.

", + "smithy.api#xmlName": "med" + } + }, + "NextHopIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextHopIp", + "smithy.api#documentation": "

The IP address for the next hop.

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

Describes a route in the route server's routing database.

" + } + }, + "com.amazonaws.ec2#RouteServerRouteInstallationDetail": { + "type": "structure", + "members": { + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table where the route is being installed.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "RouteInstallationStatus": { + "target": "com.amazonaws.ec2#RouteServerRouteInstallationStatus", + "traits": { + "aws.protocols#ec2QueryName": "RouteInstallationStatus", + "smithy.api#documentation": "

The current installation status of the route in the route table.

", + "smithy.api#xmlName": "routeInstallationStatus" + } + }, + "RouteInstallationStatusReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteInstallationStatusReason", + "smithy.api#documentation": "

The reason for the current installation status of the route.

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

Describes the installation status of a route in a route table.

" + } + }, + "com.amazonaws.ec2#RouteServerRouteInstallationDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerRouteInstallationDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerRouteInstallationStatus": { + "type": "enum", + "members": { + "INSTALLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "installed" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + } + } + }, + "com.amazonaws.ec2#RouteServerRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServerRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteServerRouteStatus": { + "type": "enum", + "members": { + "IN_RIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-rib" + } + }, + "IN_FIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-fib" + } + } + } + }, + "com.amazonaws.ec2#RouteServerState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#RouteServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteServer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#RouteState": { "type": "enum", "members": { @@ -100913,6 +103094,12 @@ "traits": { "smithy.api#enumValue": "nlb" } + }, + "rnat": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rnat" + } } } }, @@ -104014,7 +106201,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "StoreTaskState", - "smithy.api#documentation": "

The state of the store task (InProgress, Completed, or\n Failed).

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

The state of the store task (InProgress, Completed, or\n Failed).

", "smithy.api#xmlName": "storeTaskState" } }, @@ -104022,7 +106209,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "StoreTaskFailureReason", - "smithy.api#documentation": "

If the tasks fails, the reason for the failure is returned. If the task succeeds,\n null is returned.

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

If the tasks fails, the reason for the failure is returned. If the task succeeds,\n null is returned.

", "smithy.api#xmlName": "storeTaskFailureReason" } } @@ -107718,7 +109905,7 @@ "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", "traits": { "aws.protocols#ec2QueryName": "DefaultRouteTableAssociation", - "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default association route table.

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

Indicates whether resource attachments are automatically associated with the default\n association route table. Enabled by default. If defaultRouteTableAssociation\n is set to enable,\n Amazon Web Services Transit Gateway will create the default transit gateway route\n table.

", "smithy.api#xmlName": "defaultRouteTableAssociation" } }, @@ -107734,7 +109921,7 @@ "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", "traits": { "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", - "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

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

Indicates whether resource attachments automatically propagate routes to the default\n propagation route table. Enabled by default. If defaultRouteTablePropagation\n is set to enable,\n Amazon Web Services Transit Gateway will create the default transit gateway route\n table.

", "smithy.api#xmlName": "defaultRouteTablePropagation" } }, @@ -113984,6 +116171,18 @@ "traits": { "smithy.api#enumValue": "available" } + }, + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } } } }, diff --git a/ecr/service/2015-09-21/ecr-2015-09-21.json b/ecr/service/2015-09-21/ecr-2015-09-21.json index 30cb4e58..6cca36fe 100644 --- a/ecr/service/2015-09-21/ecr-2015-09-21.json +++ b/ecr/service/2015-09-21/ecr-2015-09-21.json @@ -1935,7 +1935,7 @@ "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "

The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.

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

The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.

\n ", "smithy.api#required": {} } }, @@ -3097,7 +3097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about the images in a repository.

\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": "

Returns metadata about the images in a repository.

\n \n

Starting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.

\n ", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3913,7 +3913,7 @@ "authorizationData": { "target": "com.amazonaws.ecr#AuthorizationDataList", "traits": { - "smithy.api#documentation": "

A list of authorization token data objects that correspond to the\n registryIds values in the request.

" + "smithy.api#documentation": "

A list of authorization token data objects that correspond to the\n registryIds values in the request.

\n \n

The size of the authorization token returned by Amazon ECR is not fixed. We recommend\n that you don't make assumptions about the maximum size.

\n " } } }, @@ -4533,7 +4533,7 @@ "imageSizeInBytes": { "target": "com.amazonaws.ecr#ImageSizeInBytes", "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

Starting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image sizes returned by DescribeImages.

\n " + "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

Starting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.

\n " } }, "imagePushedAt": { diff --git a/ecs/service/2014-11-13/ecs-2014-11-13.json b/ecs/service/2014-11-13/ecs-2014-11-13.json index 6584b815..872cc508 100644 --- a/ecs/service/2014-11-13/ecs-2014-11-13.json +++ b/ecs/service/2014-11-13/ecs-2014-11-13.json @@ -221,6 +221,9 @@ { "target": "com.amazonaws.ecs#StartTask" }, + { + "target": "com.amazonaws.ecs#StopServiceDeployment" + }, { "target": "com.amazonaws.ecs#StopTask" }, @@ -1539,7 +1542,7 @@ "assignPublicIp": { "target": "com.amazonaws.ecs#AssignPublicIp", "traits": { - "smithy.api#documentation": "

Whether the task's elastic network interface receives a public IP address.

\n

Consider the following when you set this value:

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

Whether the task's elastic network interface receives a public IP address.

\n

Consider the following when you set this value:

\n " } } }, @@ -2041,7 +2044,7 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include greater than\n\t\t\t(>), less than (<), double quotation marks (\"), or slash (/).

\n

If you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.

\n

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.

\n

If you update the cluster with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.

\n

For more information about Cloud Map, see Working with Services\n\t\t\tin the Cloud Map Developer Guide.

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

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include greater than (>), less than\n\t\t\t(<), double quotation marks (\"), or slash (/).

\n

If you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.

\n

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.

\n

If you update the cluster with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.

\n

For more information about Cloud Map, see Working with Services\n\t\t\tin the Cloud Map Developer Guide.

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

The RunTask request could not be processed due to conflicts. The provided\n\t\t\t\tclientToken is already in use with a different RunTask\n\t\t\trequest. The resourceIds are the existing task ARNs which are already\n\t\t\tassociated with the clientToken.

\n

To fix this issue:

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

The request could not be processed because of conflict in the current state of the resource.

", "smithy.api#error": "client" } }, @@ -2402,7 +2405,7 @@ "linuxParameters": { "target": "com.amazonaws.ecs#LinuxParameters", "traits": { - "smithy.api#documentation": "

Linux-specific modifications that are applied to the default Docker container configuration, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.

\n \n

This parameter is not supported for Windows containers.

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

Linux-specific modifications that are applied to the default Docker container\n\t\t\tconfiguration, such as Linux kernel capabilities. For more information see KernelCapabilities.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "secrets": { @@ -4612,7 +4615,7 @@ "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.

\n

The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting\n\t\t\treplacement tasks first and then stopping the unhealthy tasks, as long as cluster\n\t\t\tresources for starting replacement tasks are available. For more information about how\n\t\t\tthe scheduler replaces unhealthy tasks, see Amazon ECS\n\t\t\tservices.

\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and tasks in the service use the\n\t\t\tEC2 launch type, the maximum percent\n\t\t\tvalue is set to the default value. The maximum percent\n\t\t\tvalue is used to define the upper limit on the number of the tasks in the service that\n\t\t\tremain in the RUNNING state while the container instances are in the\n\t\t\t\tDRAINING state.

\n \n

You can't specify a custom maximumPercent value for a service that\n\t\t\t\tuses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.

\n \n

If the service uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types, and the tasks in the service use the Fargate launch type, the maximum\n\t\t\tpercent value is not used. The value is still returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.

\n

The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting\n\t\t\treplacement tasks first and then stopping the unhealthy tasks, as long as cluster\n\t\t\tresources for starting replacement tasks are available. For more information about how\n\t\t\tthe scheduler replaces unhealthy tasks, see Amazon ECS\n\t\t\tservices.

\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and tasks in the service use the\n\t\t\tEC2 launch type, the maximum percent\n\t\t\tvalue is set to the default value. The maximum percent\n\t\t\tvalue is used to define the upper limit on the number of the tasks in the service that\n\t\t\tremain in the RUNNING state while the container instances are in the\n\t\t\t\tDRAINING state.

\n \n

You can't specify a custom maximumPercent value for a service that\n\t\t\t\tuses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.

\n \n

If the service uses either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used. The value is\n\t\t\tstill returned when describing your service.

" } }, "minimumHealthyPercent": { @@ -5308,7 +5311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more of your service deployments.

\n

A service deployment happens when you release a software update for the service. For\n\t\t\tmore information, see Amazon ECS service\n\t\t\t\tdeployments.

" + "smithy.api#documentation": "

Describes one or more of your service deployments.

\n

A service deployment happens when you release a software update for the service. For\n\t\t\tmore information, see View service history using Amazon ECS service deployments.

" } }, "com.amazonaws.ecs#DescribeServiceDeploymentsRequest": { @@ -6946,13 +6949,13 @@ "interval": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The time period in seconds between each health check execution. You may specify between 5\n\t\t\tand 300 seconds. The default value is 30 seconds. This value applies only when you\n\t\t\tspecify a command.

" + "smithy.api#documentation": "

The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds. This value applies only when\n\t\t\tyou specify a command.

" } }, "timeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is considered a\n\t\t\tfailure. You may specify between 2 and 60 seconds. The default value is 5. This value\n\t\t\tapplies only when you specify a command.

" + "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is 5.\n\t\t\tThis value applies only when you specify a command.

" } }, "retries": { @@ -6969,7 +6972,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker\n\t\t\trun.

\n \n

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n \n

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n

The health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.

\n

Amazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.

\n

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n \n

The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):

\n \n

Consider the following task health example with 2 containers.

\n \n

Consider the following task health example with 3 containers.

\n \n

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n

The following are notes about container health check support:

\n \n

For an example of how to specify a task definition with multiple containers where container dependency is specified, see Container dependency in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker\n\t\t\trun.

\n \n

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n \n

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n

The health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.

\n

Amazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.

\n

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n \n

The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):

\n \n

Consider the following task health example with 2 containers.

\n \n

Consider the following task health example with 3 containers.

\n \n

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n

The following are notes about container health check support:

\n \n

For an example of how to specify a task definition with multiple containers where\n\t\t\tcontainer dependency is specified, see Container dependency in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#HealthStatus": { @@ -7239,7 +7242,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Linux capabilities to add or remove from the default Docker configuration for a\n\t\t\tcontainer defined in the task definition. For more detailed information about these\n\t\t\tLinux capabilities, see the capabilities(7) Linux manual page.

\n

The following describes how Docker processes the Linux capabilities specified in the add and\n\t\t\t\tdrop request parameters. For information about the latest behavior, see\n\t\t\tDocker Compose: order of cap_drop and cap_add in the Docker Community Forum.

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

The Linux capabilities to add or remove from the default Docker configuration for a\n\t\t\tcontainer defined in the task definition. For more detailed information about these\n\t\t\tLinux capabilities, see the capabilities(7) Linux manual page.

\n

The following describes how Docker processes the Linux capabilities specified in the\n\t\t\t\tadd and drop request parameters. For information about the\n\t\t\tlatest behavior, see Docker Compose: order of cap_drop and cap_add in the Docker Community\n\t\t\tForum.

\n " } }, "com.amazonaws.ecs#KeyValuePair": { @@ -8606,7 +8609,7 @@ "options": { "target": "com.amazonaws.ecs#LogConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The configuration options to send to the log driver.

\n

The options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:

\n
\n
awslogs-create-group
\n
\n

Required: No

\n

Specify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.

\n \n

Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.

\n \n
\n
awslogs-region
\n
\n

Required: Yes

\n

Specify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.

\n
\n
awslogs-group
\n
\n

Required: Yes

\n

Make sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.

\n
\n
awslogs-stream-prefix
\n
\n

Required: Yes, when using the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for the EC2 launch type,\n\t\t\t\t\t\t\trequired for the Fargate launch type.

\n

Use the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.

\n

If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.

\n

For Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.

\n

You must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.

\n
\n
awslogs-datetime-format
\n
\n

Required: No

\n

This option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don\u2019t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.

\n

One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.

\n

For more information, see awslogs-datetime-format.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n \n
\n
awslogs-multiline-pattern
\n
\n

Required: No

\n

This option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don\u2019t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.

\n

For more information, see awslogs-multiline-pattern.

\n

This option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n \n
\n
mode
\n
\n

Required: No

\n

Valid values: non-blocking | blocking\n

\n

This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto CloudWatch Logs. The delivery mode you choose affects application availability when\n\t\t\t\t\t\tthe flow of logs from container to CloudWatch is interrupted.

\n

If you use the blocking mode and the flow of logs to CloudWatch is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.

\n

If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent to CloudWatch. We recommend using\n\t\t\t\t\t\tthis mode if you want to ensure service availability and are okay with some\n\t\t\t\t\t\tlog loss. For more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.

\n
\n
max-buffer-size
\n
\n

Required: No

\n

Default value: 1m\n

\n

When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.

\n
\n
\n

To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.

\n

When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.

\n

Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.

\n

When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.

\n

When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and\n\t\t\ttls. For more information, see Under the hood: FireLens for Amazon ECS Tasks.

\n

When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.

\n

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

" + "smithy.api#documentation": "

The configuration options to send to the log driver.

\n

The options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:

\n
\n
awslogs-create-group
\n
\n

Required: No

\n

Specify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.

\n \n

Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.

\n \n
\n
awslogs-region
\n
\n

Required: Yes

\n

Specify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.

\n
\n
awslogs-group
\n
\n

Required: Yes

\n

Make sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.

\n
\n
awslogs-stream-prefix
\n
\n

Required: Yes, when using Fargate.Optional when using EC2.

\n

Use the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.

\n

If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.

\n

For Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.

\n

You must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.

\n
\n
awslogs-datetime-format
\n
\n

Required: No

\n

This option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don\u2019t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.

\n

One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.

\n

For more information, see awslogs-datetime-format.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n \n
\n
awslogs-multiline-pattern
\n
\n

Required: No

\n

This option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don\u2019t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.

\n

For more information, see awslogs-multiline-pattern.

\n

This option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n \n
\n
\n

The following options apply to all supported log drivers.

\n
\n
mode
\n
\n

Required: No

\n

Valid values: non-blocking | blocking\n

\n

This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto the log driver specified using logDriver. The delivery mode\n\t\t\t\t\t\tyou choose affects application availability when the flow of logs from\n\t\t\t\t\t\tcontainer is interrupted.

\n

If you use the blocking mode and the flow of logs is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.

\n

If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent. We recommend using this mode\n\t\t\t\t\t\tif you want to ensure service availability and are okay with some log loss.\n\t\t\t\t\t\tFor more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.

\n

You can set a default mode for all containers in a specific\n\t\t\t\t\t\tAmazon Web Services Region by using the defaultLogDriverMode account setting.\n\t\t\t\t\t\tIf you don't specify the mode option or\n\t\t\t\t\t\tconfigure the account setting, Amazon ECS will default to the\n\t\t\t\t\t\t\tblocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide.

\n
\n
max-buffer-size
\n
\n

Required: No

\n

Default value: 1m\n

\n

When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.

\n
\n
\n

To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.

\n

When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.

\n

Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.

\n

When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.

\n

When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and tls. For\n\t\t\tmore information, see Under the hood:\n\t\t\t\tFireLens for Amazon ECS Tasks.

\n

When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.

\n

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

" } }, "secretOptions": { @@ -9608,7 +9611,7 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The resource name for which to modify the account setting.

\n

The following are the valid values for the account setting name.

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

The resource name for which to modify the account setting.

\n

The following are the valid values for the account setting name.

\n ", "smithy.api#required": {} } }, @@ -9644,7 +9647,7 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The Amazon ECS account setting name to modify.

\n

The following are the valid values for the account setting name.

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

The Amazon ECS account setting name to modify.

\n

The following are the valid values for the account setting name.

\n ", "smithy.api#required": {} } }, @@ -10301,7 +10304,7 @@ "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\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n \n

If you're using the EC2 launch type or external launch type, this field is\n\t\t\toptional. Supported values are between 128 CPU units (0.125\n\t\t\tvCPUs) and 196608 CPU units (192 vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.

\n

If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

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

The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n \n

If you're using the EC2 launch type or external launch type, this field\n\t\t\tis optional. Supported values are between 128 CPU units (0.125\n\t\t\tvCPUs) and 196608 CPU units (192 vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.

\n

This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

" } }, "memory": { @@ -10355,7 +10358,7 @@ "enableFaultInjection": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Enables fault injection when you register your task definition and allows for fault injection requests \n\t\t\tto be accepted from the task's containers. The default value is false.

" + "smithy.api#documentation": "

Enables fault injection when you register your task definition and allows for fault\n\t\t\tinjection requests to be accepted from the task's containers. The default value is\n\t\t\t\tfalse.

" } } }, @@ -10556,7 +10559,7 @@ "serviceRevisionArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the service revision deployed as part of the rollback.

\n

When the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.

\n

When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.

" + "smithy.api#documentation": "

The ARN of the service revision deployed as part of the rollback.

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

Starts a new task using the specified task definition.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n \n

Amazon Elastic Inference (EI) is no longer available to customers.

\n \n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n

To manage eventual consistency, you can do the following:

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

Starts a new task using the specified task definition.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n \n

Amazon Elastic Inference (EI) is no longer available to customers.

\n \n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n

To manage eventual consistency, you can do the following:

\n \n

If you get a ConflictException error, the RunTask request could\n\t\t\tnot be processed due to conflicts. The provided clientToken is already in\n\t\t\tuse with a different RunTask request. The resourceIds are the\n\t\t\texisting task ARNs which are already associated with the clientToken.

\n

To fix this issue:

\n ", "smithy.api#examples": [ { "title": "To run a task on your default cluster", @@ -10656,7 +10659,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

\n

Each account receives a default cluster the first time you use the service, but you\n\t\t\tmay also create other clusters.

" } }, "count": { @@ -11404,7 +11407,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the service deployment.

\n

Service deployments provide a comprehensive view of your deployments. For information\n\t\t\tabout service deployments, see View service history\n\t\t\t\tusing Amazon ECS service deployments in the\n\t\t\t\n Amazon Elastic Container Service Developer Guide\n .

" + "smithy.api#documentation": "

Information about the service deployment.

\n

Service deployments provide a comprehensive view of your deployments. For information\n\t\t\tabout service deployments, see View service history using Amazon ECS service deployments in the\n\t\t\t\n Amazon Elastic Container Service Developer Guide\n .

" } }, "com.amazonaws.ecs#ServiceDeploymentAlarms": { @@ -11523,6 +11526,21 @@ "smithy.api#documentation": "

Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.

\n

The deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service revision. For\n\t\t\tmore information, see How the Amazon\n\t\t\t\tECS deployment circuit breaker detects failures in the Amazon ECS\n\t\t\t\tDeveloper Guide.

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

Message that describes the cause of the exception.

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

The service deploy ARN that you specified in the StopServiceDeployment doesn't exist. You can use ListServiceDeployments to retrieve the service deployment ARNs.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus": { "type": "enum", "members": { @@ -11585,6 +11603,12 @@ "smithy.api#enumValue": "IN_PROGRESS" } }, + "ROLLBACK_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_REQUESTED" + } + }, "ROLLBACK_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -12111,6 +12135,12 @@ "traits": { "smithy.api#enumValue": "guardDutyActivate" } + }, + "DEFAULT_LOG_DRIVER_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "defaultLogDriverMode" + } } } }, @@ -12368,6 +12398,106 @@ "target": "com.amazonaws.ecs#KeyValuePair" } }, + "com.amazonaws.ecs#StopServiceDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#StopServiceDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.ecs#StopServiceDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ConflictException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceDeploymentNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an ongoing service deployment.

\n \n

StopServiceDeployment isn't currently supported.

\n ", + "smithy.api#examples": [ + { + "title": "To stop a service deployment", + "documentation": "This example stops the service deployment using the ROLLBACK option.", + "input": { + "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r", + "stopType": "ROLLBACK" + }, + "output": { + "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r" + } + } + ] + } + }, + "com.amazonaws.ecs#StopServiceDeploymentRequest": { + "type": "structure", + "members": { + "serviceDeploymentArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the service deployment that you want to stop.

", + "smithy.api#required": {} + } + }, + "stopType": { + "target": "com.amazonaws.ecs#StopServiceDeploymentStopType", + "traits": { + "smithy.api#documentation": "

How you want Amazon ECS to stop the service.

\n

The ROLLBACK and ABORT stopType aren't supported.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#StopServiceDeploymentResponse": { + "type": "structure", + "members": { + "serviceDeploymentArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the stopped service deployment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ecs#StopServiceDeploymentStopType": { + "type": "enum", + "members": { + "ABORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORT" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + } + } + }, "com.amazonaws.ecs#StopTask": { "type": "operation", "input": { @@ -12887,7 +13017,7 @@ "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

\n

In order to tag a service that has the following ARN format, you need to migrate the\n\t\t\tservice to the long ARN. For more information, see Migrate an Amazon ECS short service ARN to a long ARN in the Amazon Elastic Container Service\n\t\t\t\tDeveloper Guide.

\n

\n arn:aws:ecs:region:aws_account_id:service/service-name\n

\n

After the migration is complete, the service has the long ARN format, as shown below. Use this ARN to tag the service.

\n

\n arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name\n

\n

If you try to tag a service with a short ARN, you receive an InvalidParameterException error.

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

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

\n

In order to tag a service that has the following ARN format, you need to migrate the\n\t\t\tservice to the long ARN. For more information, see Migrate an Amazon ECS short service ARN to a long ARN in the Amazon Elastic Container Service\n\t\t\t\tDeveloper Guide.

\n

\n arn:aws:ecs:region:aws_account_id:service/service-name\n

\n

After the migration is complete, the service has the long ARN format, as shown below. Use this ARN to tag the service.

\n

\n arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name\n

\n

If you try to tag a service with a short ARN, you receive an\n\t\t\t\tInvalidParameterException error.

", "smithy.api#required": {} } }, @@ -13033,7 +13163,7 @@ "cpu": { "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\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.

\n

If you're using the EC2 launch type or the external launch type, this field is\n\t\t\toptional. Supported values are between 128 CPU units (0.125\n\t\t\tvCPUs) and 196608 CPU units (192 vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.

\n

If you're using the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

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

The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.

\n

If you're using the EC2 launch type or the external launch type, this field is\n\t\t\toptional. Supported values are between 128 CPU units (0.125\n\t\t\tvCPUs) and 196608 CPU units (192 vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.

\n

This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

" } }, "createdAt": { @@ -13296,7 +13426,7 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.

\n

If you're using the EC2 launch type or the external launch type, this\n\t\t\tfield is optional. Supported values are between 128 CPU units\n\t\t\t\t(0.125 vCPUs) and 196608 CPU units (192\n\t\t\tvCPUs). The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

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

The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.

\n

If you're using the EC2 launch type or the external launch type, this\n\t\t\tfield is optional. Supported values are between 128 CPU units\n\t\t\t\t(0.125 vCPUs) and 196608 CPU units (192\n\t\t\tvCPUs).

\n

This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

" } }, "memory": { @@ -13356,7 +13486,7 @@ "enableFaultInjection": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Enables fault injection and allows for fault injection requests to be accepted from the task's containers. \n\t\t\tThe default value is false.

" + "smithy.api#documentation": "

Enables fault injection and allows for fault injection requests to be accepted from\n\t\t\tthe task's containers. The default value is false.

" } } }, diff --git a/eks/service/2017-11-01/eks-2017-11-01.json b/eks/service/2017-11-01/eks-2017-11-01.json index 35486d32..4ca50eeb 100644 --- a/eks/service/2017-11-01/eks-2017-11-01.json +++ b/eks/service/2017-11-01/eks-2017-11-01.json @@ -139,6 +139,12 @@ "traits": { "smithy.api#enumValue": "AL2023_x86_64_NVIDIA" } + }, + "AL2023_ARM_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2023_ARM_64_NVIDIA" + } } } }, @@ -2648,7 +2654,7 @@ "remoteNetworkConfig": { "target": "com.amazonaws.eks#RemoteNetworkConfigResponse", "traits": { - "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\n configuration after the cluster is created.

" } }, "computeConfig": { @@ -3606,7 +3612,7 @@ "remoteNetworkConfig": { "target": "com.amazonaws.eks#RemoteNetworkConfigRequest", "traits": { - "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\n configuration after the cluster is created.

" } }, "computeConfig": { @@ -9779,7 +9785,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\n configuration after the cluster is created.

" } }, "com.amazonaws.eks#RemoteNetworkConfigResponse": { @@ -9799,7 +9805,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this\n configuration after the cluster is created.

" + "smithy.api#documentation": "

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this\n configuration after the cluster is created.

" } }, "com.amazonaws.eks#RemoteNodeNetwork": { @@ -10677,7 +10683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the\n update. The response output includes an update ID that you can use to track the status\n of your cluster update with DescribeUpdate\"/>.

\n

You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported\n to CloudWatch Logs. For more information, see Amazon EKS\n 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 CloudWatch Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

\n

You can also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different Availability Zones. You\n can't change which VPC the subnets are from, the subnets must be in the same VPC as the\n subnets that the cluster was created with. For more information about the VPC\n requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .

\n

You can also use this API operation to enable or disable ARC zonal shift. If zonal\n shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

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

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the\n update. The response output includes an update ID that you can use to track the status\n of your cluster update with DescribeUpdate.

\n

You can use this operation to do the following actions:

\n \n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/update-config", @@ -10744,6 +10750,9 @@ "traits": { "smithy.api#documentation": "

Update the configuration of the block storage capability of your EKS Auto Mode\n cluster. For example, enable the capability.

" } + }, + "remoteNetworkConfig": { + "target": "com.amazonaws.eks#RemoteNetworkConfigRequest" } }, "traits": { @@ -11399,6 +11408,12 @@ "traits": { "smithy.api#enumValue": "KubernetesNetworkConfig" } + }, + "REMOTE_NETWORK_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RemoteNetworkConfig" + } } } }, @@ -11619,6 +11634,12 @@ "traits": { "smithy.api#enumValue": "AutoModeUpdate" } + }, + "REMOTE_NETWORK_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RemoteNetworkConfigUpdate" + } } } }, diff --git a/elasticache/service/2015-02-02/elasticache-2015-02-02.json b/elasticache/service/2015-02-02/elasticache-2015-02-02.json index b826ca9e..a9abe6db 100644 --- a/elasticache/service/2015-02-02/elasticache-2015-02-02.json +++ b/elasticache/service/2015-02-02/elasticache-2015-02-02.json @@ -11347,7 +11347,7 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Modifies the engine listed in a cluster message. The options are redis, memcached or valkey.

" + "smithy.api#documentation": "

The engine type used by the cache cluster. The options are valkey, memcached or redis.

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

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } + }, + "ScaleConfig": { + "target": "com.amazonaws.elasticache#ScaleConfig", + "traits": { + "smithy.api#documentation": "

Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.

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

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

" } + }, + "ScaleConfig": { + "target": "com.amazonaws.elasticache#ScaleConfig", + "traits": { + "smithy.api#documentation": "

The scaling configuration changes that are pending for the Memcached cluster.

" + } } }, "traits": { @@ -14591,6 +14603,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.elasticache#ScaleConfig": { + "type": "structure", + "members": { + "ScalePercentage": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The percentage by which to scale the Memcached cluster, either horizontally by adding nodes or vertically by increasing resources.

" + } + }, + "ScaleIntervalMinutes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The time interval in seconds between scaling operations when performing gradual scaling for a Memcached cluster.

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

Configuration settings for horizontal or vertical scaling operations on Memcached clusters.

" + } + }, "com.amazonaws.elasticache#SecurityGroupIdsList": { "type": "list", "member": { diff --git a/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json b/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json index 1e671628..91228c86 100644 --- a/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json +++ b/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json @@ -964,7 +964,7 @@ "smithy.api#length": { "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$" + "smithy.api#pattern": "^[a-zA-Z_0-9- ]*$" } }, "com.amazonaws.entityresolution#AwsAccountId": { @@ -2020,7 +2020,7 @@ "type": "structure", "members": { "uniqueId": { - "target": "com.amazonaws.entityresolution#UniqueId", + "target": "com.amazonaws.entityresolution#HeaderSafeUniqueId", "traits": { "smithy.api#documentation": "

The unique ID that could not be deleted.

", "smithy.api#required": {} @@ -2082,7 +2082,7 @@ "type": "structure", "members": { "uniqueId": { - "target": "com.amazonaws.entityresolution#UniqueId", + "target": "com.amazonaws.entityresolution#HeaderSafeUniqueId", "traits": { "smithy.api#documentation": "

The unique ID of the deleted item.

", "smithy.api#required": {} @@ -2110,7 +2110,7 @@ "com.amazonaws.entityresolution#DisconnectedUniqueIdsList": { "type": "list", "member": { - "target": "com.amazonaws.entityresolution#UniqueId" + "target": "com.amazonaws.entityresolution#HeaderSafeUniqueId" } }, "com.amazonaws.entityresolution#EntityName": { @@ -2569,7 +2569,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the corresponding Match ID of a customer record if the record has been\n processed.

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

Returns the corresponding Match ID of a customer record if the record has been processed\n in a rule-based matching workflow or ML matching workflow.

\n

You can call this API as a dry run of an incremental load on the rule-based matching\n workflow.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3218,6 +3218,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.entityresolution#HeaderSafeUniqueId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 780 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$" + } + }, "com.amazonaws.entityresolution#IdMappingJobMetrics": { "type": "structure", "members": { @@ -3256,10 +3266,16 @@ "traits": { "smithy.api#documentation": "

The total number of distinct mapped target records.

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

The\n number of records remaining after loading and aggregating duplicate records. Duplicates are\n determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the\n same value in this field are considered duplicates. For example, if you specified\n \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value,\n they would count as one unique record in this metric.

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

An object containing InputRecords, RecordsNotProcessed,\n TotalRecordsProcessed, TotalMappedRecords,\n TotalMappedSourceRecords, and TotalMappedTargetRecords.

" + "smithy.api#documentation": "

An\n object that contains metrics about an ID mapping job, including counts of input records,\n processed records, and mapped records between source and target identifiers.\n

" } }, "com.amazonaws.entityresolution#IdMappingJobOutputSource": { @@ -5040,7 +5056,7 @@ "type": { "target": "com.amazonaws.entityresolution#SchemaAttributeType", "traits": { - "smithy.api#documentation": "

The type of the provider schema attribute.

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

The type of the provider schema attribute.

\n

LiveRamp supports: NAME | NAME_FIRST |\n NAME_MIDDLE | NAME_LAST | ADDRESS |\n ADDRESS_STREET1 | ADDRESS_STREET2 |\n ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE |\n ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE |\n PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID |\n PROVIDER_ID\n

\n

TransUnion supports: NAME | NAME_FIRST |\n NAME_LAST | ADDRESS | ADDRESS_CITY |\n ADDRESS_STATE | ADDRESS_COUNTRY |\n ADDRESS_POSTALCODE | PHONE_NUMBER | EMAIL_ADDRESS\n | UNIQUE_ID | DATE | IPV4 | IPV6 |\n MAID\n

\n

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS |\n UNIQUE_ID\n

", "smithy.api#required": {} } }, @@ -5365,7 +5381,7 @@ "smithy.api#length": { "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$", + "smithy.api#pattern": "^[a-zA-Z_0-9- ]*$", "smithy.api#required": {} } }, @@ -5374,7 +5390,6 @@ "traits": { "smithy.api#documentation": "

A list of MatchingKeys. The MatchingKeys must have been\n defined in the SchemaMapping. Two records are considered to match according to\n this rule if all of the MatchingKeys match.

", "smithy.api#length": { - "min": 1, "max": 15 }, "smithy.api#required": {} @@ -5555,6 +5570,24 @@ "traits": { "smithy.api#enumValue": "PROVIDER_ID" } + }, + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + }, + "MAID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAID" + } } } }, @@ -5571,14 +5604,14 @@ "type": { "target": "com.amazonaws.entityresolution#SchemaAttributeType", "traits": { - "smithy.api#documentation": "

The type of the attribute, selected from a list of values.

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

The type of the attribute, selected from a list of values.

\n

LiveRamp supports: NAME | NAME_FIRST |\n NAME_MIDDLE | NAME_LAST | ADDRESS |\n ADDRESS_STREET1 | ADDRESS_STREET2 |\n ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE |\n ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE |\n PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID |\n PROVIDER_ID\n

\n

TransUnion supports: NAME | NAME_FIRST |\n NAME_LAST | ADDRESS | ADDRESS_CITY |\n ADDRESS_STATE | ADDRESS_COUNTRY |\n ADDRESS_POSTALCODE | PHONE_NUMBER | EMAIL_ADDRESS\n | UNIQUE_ID | IPV4 | IPV6 | MAID\n

\n

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS |\n UNIQUE_ID\n

\n \n

Normalization is only supported for NAME, ADDRESS,\n PHONE, and EMAIL_ADDRESS.

\n

If you want to normalize NAME_FIRST, NAME_MIDDLE, and\n NAME_LAST, you must group them by assigning them to the\n NAME\n groupName.

\n

If you want to normalize ADDRESS_STREET1, ADDRESS_STREET2,\n ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE,\n ADDRESS_COUNTRY, and ADDRESS_POSTALCODE, you must group\n them by assigning them to the ADDRESS\n groupName.

\n

If you want to normalize PHONE_NUMBER and\n PHONE_COUNTRYCODE, you must group them by assigning them to the\n PHONE\n groupName.

\n ", "smithy.api#required": {} } }, "groupName": { "target": "com.amazonaws.entityresolution#AttributeName", "traits": { - "smithy.api#documentation": "

A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type.

\n

For example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common\n groupName will prompt Entity Resolution to concatenate them into a single\n value.

" + "smithy.api#documentation": "

A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type.

\n

For example, when working with columns such as NAME_FIRST,\n NAME_MIDDLE, and NAME_LAST, assigning them a common\n groupName will prompt Entity Resolution to concatenate them into a single\n value.

" } }, "matchKey": { @@ -5596,12 +5629,12 @@ "hashed": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates if the column values are hashed in the schema input. If the value is set to\n TRUE, the column values are hashed. If the value is set to\n FALSE, the column values are cleartext.

" + "smithy.api#documentation": "

Indicates if the column values are hashed in the schema input.

\n

If the value is set to TRUE, the column values are hashed.

\n

If the value is set to FALSE, the column values are cleartext.

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

An object containing FieldName, Type, GroupName,\n MatchKey, Hashing, and SubType.

" + "smithy.api#documentation": "

A configuration object for defining input data fields in Entity Resolution. The\n SchemaInputAttribute specifies how individual fields in your input data\n should be processed and matched.

" } }, "com.amazonaws.entityresolution#SchemaInputAttributes": { @@ -6050,20 +6083,10 @@ } } }, - "com.amazonaws.entityresolution#UniqueId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 760 - }, - "smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$" - } - }, "com.amazonaws.entityresolution#UniqueIdList": { "type": "list", "member": { - "target": "com.amazonaws.entityresolution#UniqueId" + "target": "com.amazonaws.entityresolution#HeaderSafeUniqueId" } }, "com.amazonaws.entityresolution#UntagResource": { diff --git a/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json b/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json index 9b53b444..f5a9e1c7 100644 --- a/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json +++ b/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json @@ -1606,7 +1606,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have the necessary permissons for this action.

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

You do not have the necessary permissions for this action.

", "smithy.api#error": "client" } }, @@ -1868,7 +1868,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#EventBusArn", "traits": { "smithy.api#documentation": "

The ARN of the event bus associated with the archive. Only events from this event bus are\n sent to the archive.

" } @@ -2793,13 +2793,13 @@ "ResourceConfigurationArn": { "target": "com.amazonaws.eventbridge#ResourceConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration for the resource endpoint.

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

The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

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

The Amazon Resource Name (ARN) of the resource configuration for the resource endpoint.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

" } }, "com.amazonaws.eventbridge#ConnectivityResourceParameters": { @@ -2952,7 +2952,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an archive of events with the specified settings. When you create an archive,\n incoming events might not immediately start being sent to the archive. Allow a short period of\n time for changes to take effect. If you do not specify a pattern to filter events sent to the\n archive, all events are sent to the archive except replayed events. Replayed events are not\n sent to an archive.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

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

Creates an archive of events with the specified settings. When you create an archive,\n incoming events might not immediately start being sent to the archive. Allow a short period of\n time for changes to take effect. If you do not specify a pattern to filter events sent to the\n archive, all events are sent to the archive except replayed events. Replayed events are not\n sent to an archive.

\n \n

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a \n customer managed key for any archives for the event bus as well.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

\n " } }, "com.amazonaws.eventbridge#CreateArchiveRequest": { @@ -2966,7 +2966,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#EventBusArn", "traits": { "smithy.api#documentation": "

The ARN of the event bus that sends events to the archive.

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

The number of days to retain events for. Default value is 0. If set to 0, events are\n retained indefinitely

" } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt the archive.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

\n \n

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a \n customer managed key for any archives for the event bus as well.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

\n " + } } }, "traits": { @@ -3231,7 +3237,13 @@ "InvocationConnectivityParameters": { "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", "traits": { - "smithy.api#documentation": "

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + "smithy.api#documentation": "

For connections to private APIs, the parameters to use for invoking the API.

\n

For more information, see Connecting to private APIs in the \n Amazon EventBridge User Guide\n .

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt the connection.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

" } } }, @@ -3451,7 +3463,7 @@ "KmsKeyIdentifier": { "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Managing keys in the Key Management Service\n Developer Guide.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

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

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

\n \n

Schema discovery is not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with schema discovery enabled.

    \n
    • \n
\n

To enable schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

\n \n \n

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a \n customer managed key for any archives for the event bus as well.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

\n " } }, "DeadLetterConfig": { @@ -4227,7 +4239,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#EventBusArn", "traits": { "smithy.api#documentation": "

The ARN of the event source associated with the archive.

" } @@ -4256,6 +4268,12 @@ "smithy.api#documentation": "

The reason that the archive is in the state.

" } }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

" + } + }, "RetentionDays": { "target": "com.amazonaws.eventbridge#RetentionDays", "traits": { @@ -4350,7 +4368,7 @@ "ResourceAssociationArn": { "target": "com.amazonaws.eventbridge#ResourceAssociationArn", "traits": { - "smithy.api#documentation": "

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

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

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

\n

For more information, see \n Managing service network resource associations for connections in the \n Amazon EventBridge User Guide\n .

", "smithy.api#required": {} } } @@ -4383,7 +4401,7 @@ "InvocationConnectivityParameters": { "target": "com.amazonaws.eventbridge#DescribeConnectionConnectivityParameters", "traits": { - "smithy.api#documentation": "

For connections to private resource endpoints. The parameters EventBridge uses to invoke the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + "smithy.api#documentation": "

For connections to private APIs The parameters EventBridge uses to invoke the resource\n endpoint.

\n

For more information, see Connecting to private APIs in the \n Amazon EventBridge User Guide\n .

" } }, "ConnectionState": { @@ -4410,6 +4428,12 @@ "smithy.api#documentation": "

The ARN of the secret created from the authorization parameters specified for the\n connection.

" } }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use to encrypt the connection, if one has been specified.

\n

For more information, see Encrypting connections in the Amazon EventBridge User Guide.

" + } + }, "AuthParameters": { "target": "com.amazonaws.eventbridge#ConnectionAuthResponseParameters", "traits": { @@ -4862,7 +4886,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#ArchiveArn", "traits": { "smithy.api#documentation": "

The ARN of the archive events were replayed from.

" } @@ -5497,6 +5521,16 @@ "smithy.api#documentation": "

An event bus receives events from a source, uses rules to evaluate them, applies any\n configured input transformation, and routes them to the appropriate target(s). Your account's\n default event bus receives events from Amazon Web Services services. A custom event bus can\n receive events from your custom applications and services. A partner event bus receives events\n from an event source created by an SaaS partner. These events come from the partners services\n or applications.

" } }, + "com.amazonaws.eventbridge#EventBusArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:events:([a-z]|\\d|\\-)*:([0-9]{12})?:.+\\/.+$" + } + }, "com.amazonaws.eventbridge#EventBusDescription": { "type": "string", "traits": { @@ -5905,7 +5939,8 @@ "smithy.api#length": { "min": 0, "max": 2048 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-/:]*$" } }, "com.amazonaws.eventbridge#LaunchType": { @@ -6059,7 +6094,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#EventBusArn", "traits": { "smithy.api#documentation": "

The ARN of the event source associated with the archive.

" } @@ -6544,7 +6579,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#ArchiveArn", "traits": { "smithy.api#documentation": "

The ARN of the archive from which the events are replayed.

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

Sends custom events to Amazon EventBridge so that they can be matched to rules.

\n

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including\n the event and any necessary characters and keys of the JSON representation of the event. To\n learn more, see Calculating PutEvents event entry\n size in the \n Amazon EventBridge User Guide\n \n

\n

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the\n constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of\n 9,223,372,036,854,775,807.

\n \n

PutEvents will only process nested JSON up to 1000 levels deep.

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

Sends custom events to Amazon EventBridge so that they can be matched to rules.

\n

You can batch multiple event entries into one request for efficiency. \n However, the total entry size must be less than 256KB. You can calculate the entry size before you send the events. \n For more information, see Calculating PutEvents event entry\n size in the \n Amazon EventBridge User Guide\n .

\n

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the\n constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of\n 9,223,372,036,854,775,807.

\n \n

PutEvents will only process nested JSON up to 1000 levels deep.

\n " } }, "com.amazonaws.eventbridge#PutEventsRequest": { @@ -8110,7 +8145,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#ArchiveArn", "traits": { "smithy.api#documentation": "

The ARN of the archive to replay event from.

" } @@ -8633,20 +8668,20 @@ "Name": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterName", "traits": { - "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker Model Building\n Pipeline.

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

Name of parameter to start execution of a SageMaker AI Model Building\n Pipeline.

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

Value of parameter to start execution of a SageMaker Model Building\n Pipeline.

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

Value of parameter to start execution of a SageMaker AI Model Building\n Pipeline.

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

Name/Value pair of a parameter to start execution of a SageMaker Model Building\n Pipeline.

" + "smithy.api#documentation": "

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building\n Pipeline.

" } }, "com.amazonaws.eventbridge#SageMakerPipelineParameterList": { @@ -8686,12 +8721,12 @@ "PipelineParameterList": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameterList", "traits": { - "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline\n execution.

" + "smithy.api#documentation": "

List of Parameter names and values for SageMaker AI Model Building Pipeline\n execution.

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

These are custom parameters to use when the target is a SageMaker Model Building\n Pipeline that starts based on EventBridge events.

" + "smithy.api#documentation": "

These are custom parameters to use when the target is a SageMaker AI Model Building\n Pipeline that starts based on EventBridge events.

" } }, "com.amazonaws.eventbridge#ScheduleExpression": { @@ -8819,7 +8854,7 @@ } }, "EventSourceArn": { - "target": "com.amazonaws.eventbridge#Arn", + "target": "com.amazonaws.eventbridge#ArchiveArn", "traits": { "smithy.api#documentation": "

The ARN of the archive to replay events from.

", "smithy.api#required": {} @@ -9105,7 +9140,7 @@ "SageMakerPipelineParameters": { "target": "com.amazonaws.eventbridge#SageMakerPipelineParameters", "traits": { - "smithy.api#documentation": "

Contains the SageMaker Model Building Pipeline parameters to start execution of a\n SageMaker Model Building Pipeline.

\n

If you specify a SageMaker Model Building Pipeline as a target, you can use this\n to specify parameters to start a pipeline execution based on EventBridge events.

" + "smithy.api#documentation": "

Contains the SageMaker AI Model Building Pipeline parameters to start execution of a\n SageMaker AI Model Building Pipeline.

\n

If you specify a SageMaker AI Model Building Pipeline as a target, you can use this\n to specify parameters to start a pipeline execution based on EventBridge events.

" } }, "DeadLetterConfig": { @@ -9520,6 +9555,12 @@ "traits": { "smithy.api#documentation": "

The number of days to retain events in the archive.

" } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt the archive.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

\n \n

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a \n customer managed key for any archives for the event bus as well.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

\n " + } } }, "traits": { @@ -9751,7 +9792,13 @@ "InvocationConnectivityParameters": { "target": "com.amazonaws.eventbridge#ConnectivityResourceParameters", "traits": { - "smithy.api#documentation": "

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

\n

For more information, see Connecting to private resources in the \n Amazon EventBridge User Guide\n .

" + "smithy.api#documentation": "

For connections to private APIs, the parameters to use for invoking the API.

\n

For more information, see Connecting to private APIs in the \n Amazon EventBridge User Guide\n .

" + } + }, + "KmsKeyIdentifier": { + "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt the connection.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

" } } }, @@ -9965,7 +10012,7 @@ "KmsKeyIdentifier": { "target": "com.amazonaws.eventbridge#KmsKeyIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Managing keys in the Key Management Service\n Developer Guide.

\n \n

Archives and schema discovery are not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateArchive\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with an archives or schema discovery enabled.

    \n
    • \n
\n

To enable archives or schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

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

The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

\n

If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt events on the event bus.

\n

For more information, see Identify and view keys in the Key Management Service\n Developer Guide.

\n \n

Schema discovery is not supported for event buses encrypted using a\n customer managed key. EventBridge returns an error if:

\n
    \n
  • \n

    You call \n CreateDiscoverer\n on an event bus set to use a customer managed key for encryption.

    \n
    • \n
  • \n

    You call \n UpdatedEventBus\n to set a customer managed key on an event bus with schema discovery enabled.

    \n
    • \n
\n

To enable schema discovery on an event bus, choose to\n use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

\n \n \n

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a \n customer managed key for any archives for the event bus as well.

\n

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

\n " } }, "Description": { diff --git a/firehose/service/2015-08-04/firehose-2015-08-04.json b/firehose/service/2015-08-04/firehose-2015-08-04.json index a2034a1f..414e56b5 100644 --- a/firehose/service/2015-08-04/firehose-2015-08-04.json +++ b/firehose/service/2015-08-04/firehose-2015-08-04.json @@ -962,7 +962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Firehose stream.

\n

By default, you can create up to 50 Firehose streams per Amazon Web Services\n Region.

\n

This is an asynchronous operation that immediately returns. The initial status of the\n Firehose stream is CREATING. After the Firehose stream is created, its status\n is ACTIVE and it now accepts data. If the Firehose stream creation fails, the\n status transitions to CREATING_FAILED. Attempts to send data to a delivery\n stream that is not in the ACTIVE state cause an exception. To check the state\n of a Firehose stream, use DescribeDeliveryStream.

\n

If the status of a Firehose stream is CREATING_FAILED, this status\n doesn't change, and you can't invoke CreateDeliveryStream again on it.\n However, you can invoke the DeleteDeliveryStream operation to delete\n it.

\n

A Firehose stream can be configured to receive records directly\n from providers using PutRecord or PutRecordBatch, or it\n can be configured to use an existing Kinesis stream as its source. To specify a Kinesis\n data stream as input, set the DeliveryStreamType parameter to\n KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name\n (ARN) and role ARN in the KinesisStreamSourceConfiguration\n parameter.

\n

To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is\n optional. You can also invoke StartDeliveryStreamEncryption to turn on\n SSE for an existing Firehose stream that doesn't have SSE enabled.

\n

A Firehose stream is configured with a single destination, such as Amazon Simple\n Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch\n Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by\n third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New\n Relic, and Sumo Logic. You must specify only one of the following destination configuration\n parameters: ExtendedS3DestinationConfiguration,\n S3DestinationConfiguration,\n ElasticsearchDestinationConfiguration,\n RedshiftDestinationConfiguration, or\n SplunkDestinationConfiguration.

\n

When you specify S3DestinationConfiguration, you can also provide the\n following optional values: BufferingHints, EncryptionConfiguration, and\n CompressionFormat. By default, if no BufferingHints value is\n provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever\n condition is satisfied first. BufferingHints is a hint, so there are some\n cases where the service cannot adhere to these conditions strictly. For example, record\n boundaries might be such that the size is a little over or under the configured buffering\n size. By default, no encryption is performed. We strongly recommend that you enable\n encryption to ensure secure data storage in Amazon S3.

\n

A few notes about Amazon Redshift as a destination:

\n \n

Firehose assumes the IAM role that is configured as part of the\n destination. The role should allow the Firehose principal to assume the role,\n and the role should have permissions that allow the service to deliver the data. For more\n information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.

" + "smithy.api#documentation": "

Creates a Firehose stream.

\n

By default, you can create up to 5,000 Firehose streams per Amazon Web Services\n Region.

\n

This is an asynchronous operation that immediately returns. The initial status of the\n Firehose stream is CREATING. After the Firehose stream is created, its status\n is ACTIVE and it now accepts data. If the Firehose stream creation fails, the\n status transitions to CREATING_FAILED. Attempts to send data to a delivery\n stream that is not in the ACTIVE state cause an exception. To check the state\n of a Firehose stream, use DescribeDeliveryStream.

\n

If the status of a Firehose stream is CREATING_FAILED, this status\n doesn't change, and you can't invoke CreateDeliveryStream again on it.\n However, you can invoke the DeleteDeliveryStream operation to delete\n it.

\n

A Firehose stream can be configured to receive records directly\n from providers using PutRecord or PutRecordBatch, or it\n can be configured to use an existing Kinesis stream as its source. To specify a Kinesis\n data stream as input, set the DeliveryStreamType parameter to\n KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name\n (ARN) and role ARN in the KinesisStreamSourceConfiguration\n parameter.

\n

To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is\n optional. You can also invoke StartDeliveryStreamEncryption to turn on\n SSE for an existing Firehose stream that doesn't have SSE enabled.

\n

A Firehose stream is configured with a single destination, such as Amazon Simple\n Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch\n Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by\n third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New\n Relic, and Sumo Logic. You must specify only one of the following destination configuration\n parameters: ExtendedS3DestinationConfiguration,\n S3DestinationConfiguration,\n ElasticsearchDestinationConfiguration,\n RedshiftDestinationConfiguration, or\n SplunkDestinationConfiguration.

\n

When you specify S3DestinationConfiguration, you can also provide the\n following optional values: BufferingHints, EncryptionConfiguration, and\n CompressionFormat. By default, if no BufferingHints value is\n provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever\n condition is satisfied first. BufferingHints is a hint, so there are some\n cases where the service cannot adhere to these conditions strictly. For example, record\n boundaries might be such that the size is a little over or under the configured buffering\n size. By default, no encryption is performed. We strongly recommend that you enable\n encryption to ensure secure data storage in Amazon S3.

\n

A few notes about Amazon Redshift as a destination:

\n \n

Firehose assumes the IAM role that is configured as part of the\n destination. The role should allow the Firehose principal to assume the role,\n and the role should have permissions that allow the service to deliver the data. For more\n information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.

" } }, "com.amazonaws.firehose#CreateDeliveryStreamInput": { diff --git a/glue/service/2017-03-31/glue-2017-03-31.json b/glue/service/2017-03-31/glue-2017-03-31.json index 0d96d164..c2c863df 100644 --- a/glue/service/2017-03-31/glue-2017-03-31.json +++ b/glue/service/2017-03-31/glue-2017-03-31.json @@ -7449,6 +7449,12 @@ "type": "list", "member": { "target": "com.amazonaws.glue#Condition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } } }, "com.amazonaws.glue#ConfigValueString": { @@ -8141,6 +8147,27 @@ } } }, + "com.amazonaws.glue#ConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.glue#ConnectionStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ConnectionString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, "com.amazonaws.glue#ConnectionType": { "type": "enum", "members": { @@ -8356,7 +8383,7 @@ "type": "structure", "members": { "Connections": { - "target": "com.amazonaws.glue#OrchestrationStringList", + "target": "com.amazonaws.glue#ConnectionStringList", "traits": { "smithy.api#documentation": "

A list of connections used by the job.

" } @@ -12205,7 +12232,7 @@ } }, "Description": { - "target": "com.amazonaws.glue#GenericString", + "target": "com.amazonaws.glue#WorkflowDescriptionString", "traits": { "smithy.api#documentation": "

A description of the workflow.

" } @@ -25639,11 +25666,18 @@ "smithy.api#documentation": "

The number of files removed by the compaction job run.

" } }, + "DpuHours": { + "target": "com.amazonaws.glue#dpuHours", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + } + }, "NumberOfDpus": { "target": "com.amazonaws.glue#dpuCounts", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + "smithy.api#documentation": "

The number of DPUs consumed by the job, rounded up to the nearest whole number.

" } }, "JobDurationInHour": { @@ -25709,11 +25743,18 @@ "smithy.api#documentation": "

The number of orphan files deleted by the orphan file deletion job run.

" } }, + "DpuHours": { + "target": "com.amazonaws.glue#dpuHours", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + } + }, "NumberOfDpus": { "target": "com.amazonaws.glue#dpuCounts", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + "smithy.api#documentation": "

The number of DPUs consumed by the job, rounded up to the nearest whole number.

" } }, "JobDurationInHour": { @@ -25778,11 +25819,18 @@ "smithy.api#documentation": "

The number of manifest lists deleted by the retention job run.

" } }, + "DpuHours": { + "target": "com.amazonaws.glue#dpuHours", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + } + }, "NumberOfDpus": { "target": "com.amazonaws.glue#dpuCounts", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + "smithy.api#documentation": "

The number of DPUs consumed by the job, rounded up to the nearest whole number.

" } }, "JobDurationInHour": { @@ -34975,7 +35023,7 @@ "NumberOfDpus": { "target": "com.amazonaws.glue#MessageString", "traits": { - "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + "smithy.api#documentation": "

The number of DPUs consumed by the job, rounded up to the nearest whole number.

" } }, "JobDurationInHour": { @@ -44398,7 +44446,7 @@ } }, "Description": { - "target": "com.amazonaws.glue#GenericString", + "target": "com.amazonaws.glue#WorkflowDescriptionString", "traits": { "smithy.api#documentation": "

The description of the workflow.

" } @@ -45153,6 +45201,15 @@ "smithy.api#documentation": "

A workflow is a collection of multiple dependent Glue \n jobs and crawlers that are run to complete a complex ETL task. A\n workflow manages the execution and monitoring of all its jobs and crawlers.

" } }, + "com.amazonaws.glue#WorkflowDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120000 + } + } + }, "com.amazonaws.glue#WorkflowGraph": { "type": "structure", "members": { @@ -45458,6 +45515,12 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#dpuHours": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.glue#glueConnectionNameString": { "type": "string", "traits": { diff --git a/groundstation/service/2019-05-23/groundstation-2019-05-23.json b/groundstation/service/2019-05-23/groundstation-2019-05-23.json index c9f4e0ff..0ded1be8 100644 --- a/groundstation/service/2019-05-23/groundstation-2019-05-23.json +++ b/groundstation/service/2019-05-23/groundstation-2019-05-23.json @@ -94,26 +94,32 @@ } }, "com.amazonaws.groundstation#AgentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } } }, "com.amazonaws.groundstation#AggregateStatus": { @@ -138,18 +144,20 @@ } }, "com.amazonaws.groundstation#AngleUnits": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEGREE_ANGLE", - "name": "DEGREE_ANGLE" - }, - { - "value": "RADIAN", - "name": "RADIAN" + "type": "enum", + "members": { + "DEGREE_ANGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEGREE_ANGLE" } - ] + }, + "RADIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RADIAN" + } + } } }, "com.amazonaws.groundstation#AntennaDemodDecodeDetails": { @@ -249,18 +257,20 @@ } }, "com.amazonaws.groundstation#AuditResults": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HEALTHY", - "name": "HEALTHY" - }, - { - "value": "UNHEALTHY", - "name": "UNHEALTHY" + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" } - ] + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } } }, "com.amazonaws.groundstation#AwsGroundStationAgentEndpoint": { @@ -305,22 +315,26 @@ } }, "com.amazonaws.groundstation#BandwidthUnits": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GHz", - "name": "GHZ" - }, - { - "value": "MHz", - "name": "MHZ" - }, - { - "value": "kHz", - "name": "KHZ" + "type": "enum", + "members": { + "GHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GHz" } - ] + }, + "MHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MHz" + } + }, + "KHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kHz" + } + } } }, "com.amazonaws.groundstation#BucketArn": { @@ -398,53 +412,67 @@ } }, "com.amazonaws.groundstation#CapabilityHealth": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNHEALTHY", - "name": "UNHEALTHY" - }, - { - "value": "HEALTHY", - "name": "HEALTHY" + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" } - ] + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } } }, "com.amazonaws.groundstation#CapabilityHealthReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NO_REGISTERED_AGENT", - "name": "NO_REGISTERED_AGENT" - }, - { - "value": "INVALID_IP_OWNERSHIP", - "name": "INVALID_IP_OWNERSHIP" - }, - { - "value": "NOT_AUTHORIZED_TO_CREATE_SLR", - "name": "NOT_AUTHORIZED_TO_CREATE_SLR" - }, - { - "value": "UNVERIFIED_IP_OWNERSHIP", - "name": "UNVERIFIED_IP_OWNERSHIP" - }, - { - "value": "INITIALIZING_DATAPLANE", - "name": "INITIALIZING_DATAPLANE" - }, - { - "value": "DATAPLANE_FAILURE", - "name": "DATAPLANE_FAILURE" - }, - { - "value": "HEALTHY", - "name": "HEALTHY" + "type": "enum", + "members": { + "NO_REGISTERED_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_REGISTERED_AGENT" } - ] + }, + "INVALID_IP_OWNERSHIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_IP_OWNERSHIP" + } + }, + "NOT_AUTHORIZED_TO_CREATE_SLR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AUTHORIZED_TO_CREATE_SLR" + } + }, + "UNVERIFIED_IP_OWNERSHIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNVERIFIED_IP_OWNERSHIP" + } + }, + "INITIALIZING_DATAPLANE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING_DATAPLANE" + } + }, + "DATAPLANE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATAPLANE_FAILURE" + } + }, + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + } } }, "com.amazonaws.groundstation#CapabilityHealthReasonList": { @@ -486,21 +514,18 @@ "bytesSent": { "target": "smithy.api#Long", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Bytes sent by the component.

" } }, "bytesReceived": { "target": "smithy.api#Long", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Bytes received by the component.

" } }, "packetsDropped": { "target": "smithy.api#Long", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Packets dropped by component.

" } }, @@ -606,42 +631,59 @@ "type": "AWS::GroundStation::Config", "service": "GroundStation", "resource": "Config" - } + }, + "smithy.api#length": { + "min": 82, + "max": 424 + }, + "smithy.api#pattern": "^arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?$" } }, "com.amazonaws.groundstation#ConfigCapabilityType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "antenna-downlink", - "name": "ANTENNA_DOWNLINK" - }, - { - "value": "antenna-downlink-demod-decode", - "name": "ANTENNA_DOWNLINK_DEMOD_DECODE" - }, - { - "value": "antenna-uplink", - "name": "ANTENNA_UPLINK" - }, - { - "value": "dataflow-endpoint", - "name": "DATAFLOW_ENDPOINT" - }, - { - "value": "tracking", - "name": "TRACKING" - }, - { - "value": "uplink-echo", - "name": "UPLINK_ECHO" - }, - { - "value": "s3-recording", - "name": "S3_RECORDING" + "type": "enum", + "members": { + "ANTENNA_DOWNLINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "antenna-downlink" } - ] + }, + "ANTENNA_DOWNLINK_DEMOD_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "antenna-downlink-demod-decode" + } + }, + "TRACKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tracking" + } + }, + "DATAFLOW_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dataflow-endpoint" + } + }, + "ANTENNA_UPLINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "antenna-uplink" + } + }, + "UPLINK_ECHO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uplink-echo" + } + }, + "S3_RECORDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3-recording" + } + } } }, "com.amazonaws.groundstation#ConfigDetails": { @@ -951,62 +993,86 @@ } }, "com.amazonaws.groundstation#ContactStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "AWS_CANCELLED", - "name": "AWS_CANCELLED" - }, - { - "value": "AWS_FAILED", - "name": "AWS_FAILED" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "CANCELLING", - "name": "CANCELLING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "FAILED_TO_SCHEDULE", - "name": "FAILED_TO_SCHEDULE" - }, - { - "value": "PASS", - "name": "PASS" - }, - { - "value": "POSTPASS", - "name": "POSTPASS" - }, - { - "value": "PREPASS", - "name": "PREPASS" - }, - { - "value": "SCHEDULED", - "name": "SCHEDULED" - }, - { - "value": "SCHEDULING", - "name": "SCHEDULING" + "type": "enum", + "members": { + "SCHEDULING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULING" } - ] + }, + "FAILED_TO_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_TO_SCHEDULE" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "AWS_CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_CANCELLED" + } + }, + "PREPASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPASS" + } + }, + "PASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASS" + } + }, + "POSTPASS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTPASS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "AWS_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_FAILED" + } + } } }, "com.amazonaws.groundstation#CreateConfig": { @@ -1100,7 +1166,7 @@ "endpointDetails": { "target": "com.amazonaws.groundstation#EndpointDetailsList", "traits": { - "smithy.api#documentation": "

Endpoint details of each endpoint in the dataflow endpoint group.

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

Endpoint details of each endpoint in the dataflow endpoint group.\n\n All dataflow endpoints within a single dataflow endpoint group must be of the same type.\n You cannot mix \n AWS Ground Station Agent endpoints with\n Dataflow endpoints in the same group.\n If your use case requires both types of endpoints, you must create separate dataflow endpoint\n groups for each type.\n

", "smithy.api#required": {} } }, @@ -1167,7 +1233,6 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Whether to set the ephemeris status to ENABLED after validation.

\n

Setting this to false will set the ephemeris status to DISABLED after validation.

" } }, @@ -1304,22 +1369,26 @@ } }, "com.amazonaws.groundstation#Criticality": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PREFERRED", - "name": "PREFERRED" - }, - { - "value": "REMOVED", - "name": "REMOVED" - }, - { - "value": "REQUIRED", - "name": "REQUIRED" + "type": "enum", + "members": { + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" } - ] + }, + "PREFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFERRED" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVED" + } + } } }, "com.amazonaws.groundstation#CustomerEphemerisPriority": { @@ -1464,7 +1533,12 @@ "type": "AWS::GroundStation::DataflowEndpointGroup", "service": "GroundStation", "resource": "DataflowEndpointGroup" - } + }, + "smithy.api#length": { + "min": 97, + "max": 146 + }, + "smithy.api#pattern": "^arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:dataflow-endpoint-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.groundstation#DataflowEndpointGroupDurationInSeconds": { @@ -2011,7 +2085,6 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Whether or not the ephemeris is enabled.

" } }, @@ -2141,14 +2214,14 @@ } }, "com.amazonaws.groundstation#EirpUnits": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "dBW", - "name": "DBW" + "type": "enum", + "members": { + "DBW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dBW" } - ] + } } }, "com.amazonaws.groundstation#Elevation": { @@ -2224,30 +2297,38 @@ } }, "com.amazonaws.groundstation#EndpointStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "created", - "name": "created" - }, - { - "value": "creating", - "name": "creating" - }, - { - "value": "deleted", - "name": "deleted" - }, - { - "value": "deleting", - "name": "deleting" - }, - { - "value": "failed", - "name": "failed" + "type": "enum", + "members": { + "created": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "created" } - ] + }, + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } } }, "com.amazonaws.groundstation#EphemeridesList": { @@ -2336,35 +2417,43 @@ } }, "com.amazonaws.groundstation#EphemerisInvalidReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "METADATA_INVALID", - "name": "METADATA_INVALID", - "documentation": "Provided spacecraft identifiers such as spacecraft NORAD Id are invalid" - }, - { - "value": "TIME_RANGE_INVALID", - "name": "TIME_RANGE_INVALID", - "documentation": "Start, end, or expiration time(s) are invalid for the provided ephemeris" - }, - { - "value": "TRAJECTORY_INVALID", - "name": "TRAJECTORY_INVALID", - "documentation": "Provided ephemeris defines invalid spacecraft trajectory" - }, - { - "value": "KMS_KEY_INVALID", - "name": "KMS_KEY_INVALID", - "documentation": "Provided KMS key is invalid" - }, - { - "value": "VALIDATION_ERROR", - "name": "VALIDATION_ERROR", - "documentation": "Internal Service Error occurred while processing ephemeris" + "type": "enum", + "members": { + "METADATA_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Provided spacecraft identifiers such as spacecraft NORAD Id are invalid", + "smithy.api#enumValue": "METADATA_INVALID" } - ] + }, + "TIME_RANGE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Start, end, or expiration time(s) are invalid for the provided ephemeris", + "smithy.api#enumValue": "TIME_RANGE_INVALID" + } + }, + "TRAJECTORY_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Provided ephemeris defines invalid spacecraft trajectory", + "smithy.api#enumValue": "TRAJECTORY_INVALID" + } + }, + "KMS_KEY_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Provided KMS key is invalid", + "smithy.api#enumValue": "KMS_KEY_INVALID" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "Internal Service Error occurred while processing ephemeris", + "smithy.api#enumValue": "VALIDATION_ERROR" + } + } } }, "com.amazonaws.groundstation#EphemerisItem": { @@ -2391,7 +2480,6 @@ "enabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

Whether or not the ephemeris is enabled.

" } }, @@ -2461,49 +2549,61 @@ } }, "com.amazonaws.groundstation#EphemerisSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CUSTOMER_PROVIDED", - "name": "CUSTOMER_PROVIDED" - }, - { - "value": "SPACE_TRACK", - "name": "SPACE_TRACK" + "type": "enum", + "members": { + "CUSTOMER_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_PROVIDED" } - ] + }, + "SPACE_TRACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPACE_TRACK" + } + } } }, "com.amazonaws.groundstation#EphemerisStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALIDATING", - "name": "VALIDATING" - }, - { - "value": "INVALID", - "name": "INVALID" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" + "type": "enum", + "members": { + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATING" } - ] + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } } }, "com.amazonaws.groundstation#EphemerisStatusList": { @@ -2577,22 +2677,26 @@ } }, "com.amazonaws.groundstation#FrequencyUnits": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GHz", - "name": "GHZ" - }, - { - "value": "MHz", - "name": "MHZ" - }, - { - "value": "kHz", - "name": "KHZ" + "type": "enum", + "members": { + "GHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GHz" } - ] + }, + "MHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MHz" + } + }, + "KHZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kHz" + } + } } }, "com.amazonaws.groundstation#GetAgentConfiguration": { @@ -4148,7 +4252,7 @@ "min": 2, "max": 8192 }, - "smithy.api#pattern": "^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" + "smithy.api#pattern": "^[{}\\[\\]:.,\"0-9A-Za-z\\-_\\s]{2,8192}$" } }, "com.amazonaws.groundstation#KeyAliasArn": { @@ -4161,7 +4265,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "^arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((alias/[a-zA-Z0-9:/_-]{1,256}))$" + "smithy.api#pattern": "^arn:aws[a-zA-Z-]{0,16}:kms:[-a-z0-9]{1,50}:[0-9]{12}:((alias/[a-zA-Z0-9:/_-]{1,256}))$" } }, "com.amazonaws.groundstation#KeyAliasName": { @@ -4205,7 +4309,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS Key Management Service (KMS) Key.

" + "smithy.api#documentation": "

KMS key info.

" } }, "com.amazonaws.groundstation#ListConfigs": { @@ -4898,7 +5002,12 @@ "type": "AWS::GroundStation::MissionProfile", "service": "GroundStation", "resource": "MissionProfile" - } + }, + "smithy.api#length": { + "min": 89, + "max": 138 + }, + "smithy.api#pattern": "^arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.groundstation#MissionProfileIdResponse": { @@ -4986,7 +5095,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 0, + "min": 1, "max": 100 } } @@ -5002,22 +5111,26 @@ } }, "com.amazonaws.groundstation#Polarization": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LEFT_HAND", - "name": "LEFT_HAND" - }, - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "RIGHT_HAND", - "name": "RIGHT_HAND" + "type": "enum", + "members": { + "RIGHT_HAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT_HAND" } - ] + }, + "LEFT_HAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT_HAND" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } } }, "com.amazonaws.groundstation#PositiveDurationInSeconds": { @@ -5119,6 +5232,12 @@ "smithy.api#documentation": "

Detailed information about the agent being registered.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.groundstation#TagsMap", + "traits": { + "smithy.api#documentation": "

Tags assigned to an Agent.

" + } } } }, @@ -5550,6 +5669,9 @@ "polarization": { "target": "com.amazonaws.groundstation#Polarization", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#clientOptional": {}, + "smithy.api#default": "NONE", "smithy.api#documentation": "

Polarization of a spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.

" } } @@ -6179,8 +6301,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 128 + "min": 36, + "max": 36 }, "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } @@ -6233,7 +6355,12 @@ "type": "AWS::GroundStation::Satellite", "service": "com.amazon.awsgsaascontrolplanelambda.r20190311#GroundStation", "resource": "com.amazon.awsgsaascontrolplanelambda.r20190311#Satellite" - } + }, + "smithy.api#length": { + "min": 82, + "max": 132 + }, + "smithy.api#pattern": "^arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } } } diff --git a/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json b/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json index 8995d888..74ce50ac 100644 --- a/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json +++ b/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json @@ -24,6 +24,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the actuator. For example, the fully qualified name of an\n actuator might be Vehicle.Front.Left.Door.Lock.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -174,6 +179,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the attribute. For example, the fully qualified name of an\n attribute might be Vehicle.Body.Engine.Type.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -379,6 +389,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the branch. For example, the fully qualified name of a\n branch might be Vehicle.Body.Engine.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -582,7 +597,8 @@ "smithy.api#length": { "min": 1, "max": 100 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#CanSignal": { @@ -665,7 +681,8 @@ "smithy.api#length": { "min": 1, "max": 100 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#CloudWatchLogDeliveryOptions": { @@ -1059,6 +1076,7 @@ "target": "com.amazonaws.iotfleetwise#arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vehicle model (model manifest).

", + "smithy.api#pattern": "^arn:aws:iotfleetwise:[a-z0-9-]+:[0-9]{12}:model-manifest/[a-zA-Z\\d\\-_:]{1,100}$", "smithy.api#required": {} } }, @@ -1261,6 +1279,9 @@ "target": "com.amazonaws.iotfleetwise#listOfStrings", "traits": { "smithy.api#documentation": "

A list of nodes, which are a general abstraction of signals.

", + "smithy.api#length": { + "max": 500 + }, "smithy.api#required": {} } }, @@ -1790,6 +1811,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the custom property. For example, the fully qualified name\n of a custom property might be\n ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -1842,6 +1868,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the custom structure. For example, the fully qualified\n name of a custom structure might be\n ComplexDataTypes.VehicleDataTypes.SVMCamera.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -2889,7 +2920,8 @@ "smithy.api#length": { "min": 1, "max": 150 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#GetCampaign": { @@ -4202,7 +4234,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#pattern": "^[-a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#InterfaceIds": { @@ -7108,7 +7141,8 @@ "smithy.api#length": { "min": 1, "max": 100 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#ObdSignal": { @@ -7257,7 +7291,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#ProtocolVersion": { @@ -7266,7 +7301,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" } }, "com.amazonaws.iotfleetwise#PutEncryptionConfiguration": { @@ -7769,6 +7805,11 @@ "target": "com.amazonaws.iotfleetwise#string", "traits": { "smithy.api#documentation": "

The fully qualified name of the sensor. For example, the fully qualified name of a\n sensor might be Vehicle.Body.Engine.Battery.

", + "smithy.api#length": { + "min": 1, + "max": 150 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.]+$", "smithy.api#required": {} } }, @@ -9861,7 +9902,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a vehicle.

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

Updates a vehicle.

\n \n

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

\n ", "smithy.api#http": { "method": "PATCH", "uri": "/vehicles/{vehicleName}", @@ -9942,6 +9983,12 @@ "traits": { "smithy.api#documentation": "

Remove state templates from the vehicle.

" } + }, + "stateTemplatesToUpdate": { + "target": "com.amazonaws.iotfleetwise#StateTemplateAssociations", + "traits": { + "smithy.api#documentation": "

Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.

" + } } } }, @@ -9990,10 +10037,16 @@ "traits": { "smithy.api#documentation": "

Remove existing state template associations from the vehicle.

" } + }, + "stateTemplatesToUpdate": { + "target": "com.amazonaws.iotfleetwise#StateTemplateAssociations", + "traits": { + "smithy.api#documentation": "

Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.

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

Information about the vehicle to update.

" + "smithy.api#documentation": "

Information about the vehicle to update.

\n \n

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

\n " } }, "com.amazonaws.iotfleetwise#UpdateVehicleResponse": { @@ -10621,7 +10674,8 @@ "traits": { "smithy.api#default": 0, "smithy.api#range": { - "min": 0 + "min": 0, + "max": 2147483647 } } }, @@ -10635,7 +10689,8 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 1, + "max": 2147483647 } } }, @@ -10643,7 +10698,8 @@ "type": "long", "traits": { "smithy.api#range": { - "min": 1 + "min": 1, + "max": 9223372036854775807 } } }, @@ -10675,7 +10731,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 7, + "min": 1, "max": 20 }, "smithy.api#pattern": "^[A-Z_]*$" diff --git a/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json b/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json index 58848a57..c6c1847c 100644 --- a/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json +++ b/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json @@ -3206,6 +3206,12 @@ "smithy.api#required": {} } }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Allows you to configure destinations where error logs will be published during the bot import process.

" + } + }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.lexmodelsv2#SessionTTL", "traits": { @@ -5576,6 +5582,12 @@ "traits": { "smithy.api#documentation": "

The list of bot members in a network to be created.

" } + }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for error logging during bot creation.

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

The list of bots in a network that was created.

" } + }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Specifies configuration settings for delivering error logs to Cloudwatch Logs in an Amazon Lex bot response.

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

Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

" } + }, + "qInConnectIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration", + "traits": { + "smithy.api#documentation": "

Qinconnect intent configuration details for the create intent request.

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

Details about the the configuration of the built-in Amazon.QnAIntent.

" } + }, + "qInConnectIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration", + "traits": { + "smithy.api#documentation": "

Qinconnect intent configuration details for the create intent response.

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

If the botStatus is Failed, this contains\n a list of reasons that the bot couldn't be built.

" } + }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.

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

Details about the configuration of the built-in Amazon.QnAIntent.

" } + }, + "qInConnectIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration", + "traits": { + "smithy.api#documentation": "

Qinconnect intent configuration details for the describe intent response.

" + } } }, "traits": { @@ -11478,6 +11520,21 @@ } } }, + "com.amazonaws.lexmodelsv2#ErrorLogSettings": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Settings parameters for the error logs, when it is enabled.

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

Settings parameters for the error logs, whether it is enabled or disabled.

" + } + }, "com.amazonaws.lexmodelsv2#ErrorMessage": { "type": "string" }, @@ -18779,6 +18836,41 @@ "smithy.api#documentation": "

Specifies a list of message groups that Amazon Lex sends to a user to\n elicit a response.

" } }, + "com.amazonaws.lexmodelsv2#QInConnectAssistantARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" + } + }, + "com.amazonaws.lexmodelsv2#QInConnectAssistantConfiguration": { + "type": "structure", + "members": { + "assistantArn": { + "target": "com.amazonaws.lexmodelsv2#QInConnectAssistantARN", + "traits": { + "smithy.api#documentation": "

The assistant Arn details of the Qinconnect assistant configuration.

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

The configuration details of the Qinconnect assistant.

" + } + }, + "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration": { + "type": "structure", + "members": { + "qInConnectAssistantConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectAssistantConfiguration", + "traits": { + "smithy.api#documentation": "

The Qinconnect assistant configuration details of the Qinconnect intent.

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

The configuration details of the Qinconnect intent.

" + } + }, "com.amazonaws.lexmodelsv2#QnAIntentConfiguration": { "type": "structure", "members": { @@ -23325,6 +23417,12 @@ "traits": { "smithy.api#documentation": "

The list of bot members in the network associated \n with the update action.

" } + }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.

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

The list of bot members in the network that was updated.

" } + }, + "errorLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ErrorLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for managing error logs within the response of an update bot operation.

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

Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

" } + }, + "qInConnectIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration", + "traits": { + "smithy.api#documentation": "

Qinconnect intent configuration details for the update intent request.

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

Details about the configuration of the built-in Amazon.QnAIntent.

" } + }, + "qInConnectIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QInConnectIntentConfiguration", + "traits": { + "smithy.api#documentation": "

Qinconnect intent configuration details for the update intent response.

" + } } }, "traits": { diff --git a/m2/service/2021-04-28/m2-2021-04-28.json b/m2/service/2021-04-28/m2-2021-04-28.json index 0063cbf8..1afa585b 100644 --- a/m2/service/2021-04-28/m2-2021-04-28.json +++ b/m2/service/2021-04-28/m2-2021-04-28.json @@ -86,6 +86,9 @@ { "target": "com.amazonaws.m2#CancelBatchJobExecution" }, + { + "target": "com.amazonaws.m2#CreateDataSetExportTask" + }, { "target": "com.amazonaws.m2#CreateDataSetImportTask" }, @@ -104,6 +107,9 @@ { "target": "com.amazonaws.m2#GetDataSetDetails" }, + { + "target": "com.amazonaws.m2#GetDataSetExportTask" + }, { "target": "com.amazonaws.m2#GetDataSetImportTask" }, @@ -122,6 +128,9 @@ { "target": "com.amazonaws.m2#ListBatchJobRestartPoints" }, + { + "target": "com.amazonaws.m2#ListDataSetExportHistory" + }, { "target": "com.amazonaws.m2#ListDataSetImportHistory" }, @@ -1664,6 +1673,105 @@ } } }, + "com.amazonaws.m2#CreateDataSetExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CreateDataSetExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.m2#CreateDataSetExportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "requiredActions": [ + "s3:GetObject" + ], + "documentation": "Grants permission to create a data set export task" + }, + "smithy.api#documentation": "

Starts a data set export task for a specific application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/dataset-export-task", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#CreateDataSetExportTaskRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application for which you want to export data sets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "exportConfig": { + "target": "com.amazonaws.m2#DataSetExportConfig", + "traits": { + "smithy.api#documentation": "

The data set export task configuration.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

", + "smithy.api#idempotencyToken": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.m2#KMSKeyId", + "traits": { + "smithy.api#documentation": "

The identifier of a customer managed key.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#CreateDataSetExportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.m2#CreateDataSetImportTask": { "type": "operation", "input": { @@ -2048,6 +2156,149 @@ "smithy.api#documentation": "

Defines a data set.

" } }, + "com.amazonaws.m2#DataSetExportConfig": { + "type": "union", + "members": { + "s3Location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the data sets.

" + } + }, + "dataSets": { + "target": "com.amazonaws.m2#DataSetExportList", + "traits": { + "smithy.api#documentation": "

The data sets.

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

Identifies one or more data sets you want to import with the CreateDataSetExportTask operation.

" + } + }, + "com.amazonaws.m2#DataSetExportItem": { + "type": "structure", + "members": { + "datasetName": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The data set.

", + "smithy.api#required": {} + } + }, + "externalLocation": { + "target": "com.amazonaws.m2#ExternalLocation", + "traits": { + "smithy.api#documentation": "

The location of the data set.

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

Identifies a specific data set to export from an external location.

" + } + }, + "com.amazonaws.m2#DataSetExportList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DataSetExportItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.m2#DataSetExportSummary": { + "type": "structure", + "members": { + "total": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of data set exports.

", + "smithy.api#required": {} + } + }, + "succeeded": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data set exports that have succeeded.

", + "smithy.api#required": {} + } + }, + "failed": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data set exports that have failed.

", + "smithy.api#required": {} + } + }, + "pending": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data set exports that are pending.

", + "smithy.api#required": {} + } + }, + "inProgress": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data set exports that are in progress.

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

Represents a summary of data set exports.

" + } + }, + "com.amazonaws.m2#DataSetExportTask": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the data set export task.

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

The status of the data set export task.

", + "smithy.api#required": {} + } + }, + "summary": { + "target": "com.amazonaws.m2#DataSetExportSummary", + "traits": { + "smithy.api#documentation": "

A summary of the data set export task.

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

If dataset exports failed, the failure reason will show here.

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

Contains information about a data set export task.

" + } + }, + "com.amazonaws.m2#DataSetExportTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DataSetExportTask" + } + }, "com.amazonaws.m2#DataSetImportConfig": { "type": "union", "members": { @@ -3585,6 +3836,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.m2#GetDataSetExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetDataSetExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetDataSetExportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to export a data set at the specified S3 location" + }, + "smithy.api#documentation": "

Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/dataset-export-tasks/{taskId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetDataSetExportTaskRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The application identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier returned by the CreateDataSetExportTask operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#GetDataSetExportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier.

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

The status of the task.

", + "smithy.api#required": {} + } + }, + "summary": { + "target": "com.amazonaws.m2#DataSetExportSummary", + "traits": { + "smithy.api#documentation": "

A summary of the status of the task.

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

If dataset export failed, the failure reason will show here.

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

The identifier of a customer managed key used for exported data set encryption.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.m2#GetDataSetImportTask": { "type": "operation", "input": { @@ -4152,6 +4506,25 @@ "smithy.api#default": false, "smithy.api#documentation": "

Specifies if a step can be restarted or not.

" } + }, + "stepCheckpoint": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A registered step-level checkpoint identifier that can be used for restarting an Amazon Web Services Blu Age application batch job.

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

The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.

" + } + }, + "stepCheckpointTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.

" + } } }, "traits": { @@ -4185,12 +4558,36 @@ "traits": { "smithy.api#documentation": "

The procedure step name that a batch job was restarted to.

" } + }, + "stepCheckpoint": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.

" + } + }, + "skip": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.

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

Provides step/procedure step information for a restart batch job operation.

" } }, + "com.amazonaws.m2#KMSKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:/_-]+$" + } + }, "com.amazonaws.m2#ListApplicationVersions": { "type": "operation", "input": { @@ -4695,6 +5092,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.m2#ListDataSetExportHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListDataSetExportHistoryRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListDataSetExportHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to list data set export history" + }, + "smithy.api#documentation": "

Lists the data set exports for the specified application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/dataset-export-tasks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSetExportTasks" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListDataSetExportHistoryRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

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

The maximum number of objects to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListDataSetExportHistoryResponse": { + "type": "structure", + "members": { + "dataSetExportTasks": { + "target": "com.amazonaws.m2#DataSetExportTaskList", + "traits": { + "smithy.api#documentation": "

The data set export tasks.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.m2#ListDataSetImportHistory": { "type": "operation", "input": { diff --git a/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json b/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json index 5574459c..f4a7f606 100644 --- a/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json +++ b/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json @@ -1374,6 +1374,12 @@ "smithy.api#documentation": "

If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret\n ARN.

" } }, + "NetworkConfiguration": { + "target": "com.amazonaws.mailmanager#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the network configuration for the ingress point.\n This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.\n

" + } + }, "Tags": { "target": "com.amazonaws.mailmanager#TagList", "traits": { @@ -3289,6 +3295,12 @@ "smithy.api#documentation": "

The authentication configuration of the ingress endpoint resource.

" } }, + "NetworkConfiguration": { + "target": "com.amazonaws.mailmanager#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for the ingress point.

" + } + }, "CreatedTimestamp": { "target": "smithy.api#Timestamp", "traits": { @@ -4071,6 +4083,60 @@ "smithy.api#documentation": "

The union type representing the allowed types for the left hand side of an IP\n condition.

" } }, + "com.amazonaws.mailmanager#IngressIpv6Attribute": { + "type": "enum", + "members": { + "SENDER_IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENDER_IPV6" + } + } + } + }, + "com.amazonaws.mailmanager#IngressIpv6Expression": { + "type": "structure", + "members": { + "Evaluate": { + "target": "com.amazonaws.mailmanager#IngressIpv6ToEvaluate", + "traits": { + "smithy.api#documentation": "

The left hand side argument of an IPv6 condition expression.

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.mailmanager#IngressIpOperator", + "traits": { + "smithy.api#documentation": "

The matching operator for an IPv6 condition expression.

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

The right hand side argument of an IPv6 condition expression.

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

The union type representing the allowed types for the left hand side of an IPv6 condition.

" + } + }, + "com.amazonaws.mailmanager#IngressIpv6ToEvaluate": { + "type": "union", + "members": { + "Attribute": { + "target": "com.amazonaws.mailmanager#IngressIpv6Attribute", + "traits": { + "smithy.api#documentation": "

An enum type representing the allowed attribute types for an IPv6 condition.

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

The structure for an IPv6 based condition matching on the incoming mail.

" + } + }, "com.amazonaws.mailmanager#IngressIsInAddressList": { "type": "structure", "members": { @@ -4521,6 +4587,23 @@ "smithy.api#documentation": "

The union type representing the allowed types for the left hand side of a TLS\n condition.

" } }, + "com.amazonaws.mailmanager#IpType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL_STACK" + } + } + } + }, "com.amazonaws.mailmanager#Ipv4Cidr": { "type": "string", "traits": { @@ -4533,6 +4616,21 @@ "target": "com.amazonaws.mailmanager#Ipv4Cidr" } }, + "com.amazonaws.mailmanager#Ipv6Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 49 + }, + "smithy.api#pattern": "^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9])$" + } + }, + "com.amazonaws.mailmanager#Ipv6Cidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#Ipv6Cidr" + } + }, "com.amazonaws.mailmanager#JobId": { "type": "string", "traits": { @@ -6517,6 +6615,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9:_/+=,@.#-]+$" } }, + "com.amazonaws.mailmanager#NetworkConfiguration": { + "type": "union", + "members": { + "PublicNetworkConfiguration": { + "target": "com.amazonaws.mailmanager#PublicNetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the network configuration for the public ingress point.

" + } + }, + "PrivateNetworkConfiguration": { + "target": "com.amazonaws.mailmanager#PrivateNetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the network configuration for the private ingress point.

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

The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

" + } + }, "com.amazonaws.mailmanager#NoAuthentication": { "type": "structure", "members": {}, @@ -6557,6 +6675,12 @@ "smithy.api#documentation": "

This represents an IP based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.

" } }, + "Ipv6Expression": { + "target": "com.amazonaws.mailmanager#IngressIpv6Expression", + "traits": { + "smithy.api#documentation": "

This represents an IPv6 based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.

" + } + }, "TlsExpression": { "target": "com.amazonaws.mailmanager#IngressTlsProtocolExpression", "traits": { @@ -6619,6 +6743,37 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.mailmanager#PrivateNetworkConfiguration": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.mailmanager#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC endpoint to associate with this private ingress point.

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

Specifies the network configuration for the private ingress point.

" + } + }, + "com.amazonaws.mailmanager#PublicNetworkConfiguration": { + "type": "structure", + "members": { + "IpType": { + "target": "com.amazonaws.mailmanager#IpType", + "traits": { + "smithy.api#default": "IPV4", + "smithy.api#documentation": "

The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.

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

Specifies the network configuration for the public ingress point.

" + } + }, "com.amazonaws.mailmanager#QBusinessApplicationId": { "type": "string", "traits": { @@ -7596,9 +7751,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 18 + "max": 43 }, - "smithy.api#pattern": "^(([0-9]|.|/)*)$" + "smithy.api#pattern": "^(([0-9]|.|:|/)*)$" } }, "com.amazonaws.mailmanager#RuleIpToEvaluate": { @@ -9583,6 +9738,12 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.mailmanager#VpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^vpce-[a-zA-Z0-9]{17}$" + } } } } \ No newline at end of file diff --git a/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json b/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json index 34fbcc69..fbc44869 100644 --- a/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json +++ b/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json @@ -31,7 +31,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters (for example, API keys and external IDs) to buyers during the Quick Launch experience.

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

The AWS Marketplace Deployment Service supports the Quick Launch experience, which is a deployment option for software as a service (SaaS) products. \n Quick Launch simplifies and reduces the time, resources, and steps required to configure, deploy, and launch a products. \n The AWS Marketplace Deployment Service provides sellers with a secure method for passing deployment parameters, such as \n API keys and external IDs, to buyers during the Quick Launch experience.

", "smithy.api#title": "AWS Marketplace Deployment Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -799,7 +799,7 @@ } }, "traits": { - "smithy.api#documentation": "

The shape containing the requested deployment parameter name and secretString.

" + "smithy.api#documentation": "

The shape containing the requested deployment parameter name and secretString.

\n \n

To support AWS CloudFormation dynamic references to this resource using Quick Launch,\n this value must match a parameter defined in the CloudFormation templated provided to\n buyers.

\n " } }, "com.amazonaws.marketplacedeployment#DeploymentParameterName": { @@ -1017,7 +1017,7 @@ "catalog": { "target": "com.amazonaws.marketplacedeployment#Catalog", "traits": { - "smithy.api#documentation": "

The catalog related to the request. Fixed value: AWS Marketplace\n

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

The catalog related to the request. Fixed value: AWSMarketplace\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1060,7 +1060,7 @@ "clientToken": { "target": "com.amazonaws.marketplacedeployment#ClientToken", "traits": { - "smithy.api#documentation": "

The idempotency token for deployment parameters. A unique identifier for the new version.

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

The idempotency token for deployment parameters. A unique identifier for the new version.

\n \n

This field is not required if you're calling using an AWS SDK. Otherwise, a\n clientToken must be provided with the request.

\n ", "smithy.api#idempotencyToken": {} } } diff --git a/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json b/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json index 332c0323..b56eec55 100644 --- a/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json +++ b/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json @@ -55,12 +55,6 @@ "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, @@ -80,6 +74,12 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" } }, "rules": [ @@ -111,152 +111,158 @@ "type": "error" }, { - "conditions": [ + "conditions": [], + "rules": [ { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, - true - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree" } ], "type": "tree" }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], + "conditions": [], "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { "ref": "Region" } - ], - "assign": "PartitionResult" + ] } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false ] }, { "fn": "booleanEquals", "argv": [ - true, + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://entitlement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] - } + }, + "aws-cn" ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://entitlement.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } ], - "type": "tree" + "endpoint": { + "url": "https://entitlement-marketplace.{Region}.amazonaws.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ { "fn": "getAttr", @@ -264,165 +270,294 @@ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://entitlement-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, true ] } ], "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entitlement.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://entitlement.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ], "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, - true - ] - } - ], - "rules": [ - { - "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] }, - "supportsDualStack" + true ] } - ] - } - ], - "rules": [ + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entitlement.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://entitlement.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ], "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ + "conditions": [ { - "ref": "Region" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - "cn-northwest-1" - ] - } - ], - "endpoint": { - "url": "https://entitlement-marketplace.cn-northwest-1.amazonaws.com.cn", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws", { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + true ] } - ] + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entitlement.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://entitlement.marketplace.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], - "endpoint": { - "url": "https://entitlement.marketplace.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://entitlement.marketplace.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree" } ], "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ], "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.us-east-1.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "us-east-1", + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { @@ -455,7 +590,7 @@ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.us-east-1.api.aws" + "url": "https://entitlement-marketplace.us-east-1.api.aws" } }, "params": { @@ -465,118 +600,118 @@ } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement-marketplace.cn-northwest-1.amazonaws.com.cn" + "url": "https://entitlement.marketplace.us-east-1.amazonaws.com" } }, "params": { - "Region": "cn-northwest-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://entitlement.marketplace-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace-fips.cn-north-1.amazonaws.com.cn" + "url": "https://entitlement.marketplace-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://entitlement-marketplace.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.cn-north-1.amazonaws.com.cn" + "url": "https://entitlement-marketplace.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace-fips.us-gov-east-1.api.aws" + "url": "https://entitlement.marketplace-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace-fips.us-gov-east-1.amazonaws.com" + "url": "https://entitlement.marketplace-fips.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.us-gov-east-1.api.aws" + "url": "https://entitlement.marketplace.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.us-gov-east-1.amazonaws.com" + "url": "https://entitlement.marketplace.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } @@ -678,54 +813,99 @@ } }, { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://entitlement.marketplace-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { - "Region": "us-east-1", + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": true } }, { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://entitlement.marketplace.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", + "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": true } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "url": "https://entitlement.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { - "Region": "us-east-1", + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isof-south-1", "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entitlement.marketplace.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false } }, { diff --git a/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json b/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json index ce178edb..b215dbbb 100644 --- a/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json +++ b/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json @@ -225,6 +225,92 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -565,7 +651,7 @@ "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://metering.marketplace.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://metering-marketplace.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { @@ -617,7 +703,7 @@ "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://metering.marketplace.us-gov-west-1.api.aws" + "url": "https://metering-marketplace.us-gov-west-1.api.aws" } }, "params": { diff --git a/medialive/service/2017-10-14/medialive-2017-10-14.json b/medialive/service/2017-10-14/medialive-2017-10-14.json index bced2e81..46dfbd54 100644 --- a/medialive/service/2017-10-14/medialive-2017-10-14.json +++ b/medialive/service/2017-10-14/medialive-2017-10-14.json @@ -4516,6 +4516,32 @@ "smithy.api#documentation": "Cmaf Id3 Behavior" } }, + "com.amazonaws.medialive#CmafIngestCaptionLanguageMapping": { + "type": "structure", + "members": { + "CaptionChannel": { + "target": "com.amazonaws.medialive#__integerMin1Max4", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A number for the channel for this caption, 1 to 4.", + "smithy.api#jsonName": "captionChannel", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.medialive#__stringMin3Max3", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Language code for the language of the caption in this channel. For example, ger/deu. See http://www.loc.gov/standards/iso639-2", + "smithy.api#jsonName": "languageCode", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Add an array item for each language. Follow the order of the caption descriptions. For example, if the first caption description is for German, then the first array item must be for German, and its caption channel must be set to 1. The second array item must be 2, and so on." + } + }, "com.amazonaws.medialive#CmafIngestGroupSettings": { "type": "structure", "members": { @@ -4604,6 +4630,34 @@ "smithy.api#documentation": "Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is \"id3\", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the \"id3\" string.\\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.", "smithy.api#jsonName": "id3NameModifier" } + }, + "CaptionLanguageMappings": { + "target": "com.amazonaws.medialive#__listOfCmafIngestCaptionLanguageMapping", + "traits": { + "smithy.api#documentation": "An array that identifies the languages in the four caption channels in the embedded captions.", + "smithy.api#jsonName": "captionLanguageMappings" + } + }, + "TimedMetadataId3Frame": { + "target": "com.amazonaws.medialive#CmafTimedMetadataId3Frame", + "traits": { + "smithy.api#documentation": "Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" + } + }, + "TimedMetadataId3Period": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", + "traits": { + "smithy.api#documentation": "If you set up to insert a timecode in the output, specify the frequency for the frame, in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" + } + }, + "TimedMetadataPassthrough": { + "target": "com.amazonaws.medialive#CmafTimedMetadataPassthrough", + "traits": { + "smithy.api#documentation": "Set to enabled to pass through ID3 metadata from the input sources.", + "smithy.api#jsonName": "timedMetadataPassthrough" + } } }, "traits": { @@ -4685,6 +4739,52 @@ "smithy.api#documentation": "Cmaf Nielsen Id3 Behavior" } }, + "com.amazonaws.medialive#CmafTimedMetadataId3Frame": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRIV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIV" + } + }, + "TDRL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TDRL" + } + } + }, + "traits": { + "smithy.api#documentation": "Cmaf Timed Metadata Id3 Frame" + } + }, + "com.amazonaws.medialive#CmafTimedMetadataPassthrough": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Cmaf Timed Metadata Passthrough" + } + }, "com.amazonaws.medialive#ColorCorrection": { "type": "structure", "members": { @@ -6143,6 +6243,19 @@ "smithy.api#documentation": "Multicast Input settings.", "smithy.api#jsonName": "multicastSettings" } + }, + "Smpte2110ReceiverGroupSettings": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroupSettings", + "traits": { + "smithy.api#documentation": "Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.", + "smithy.api#jsonName": "smpte2110ReceiverGroupSettings" + } + }, + "SdiSources": { + "target": "com.amazonaws.medialive#InputSdiSources", + "traits": { + "smithy.api#jsonName": "sdiSources" + } } }, "traits": { @@ -6872,6 +6985,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -6963,6 +7083,107 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#CreateSdiSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#CreateSdiSourceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#CreateSdiSourceResponse" + }, + "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#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Create an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/sdiSources", + "code": 200 + } + } + }, + "com.amazonaws.medialive#CreateSdiSourceRequest": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.medialive#SdiSourceMode", + "traits": { + "smithy.api#documentation": "Applies only if the type is QUAD. Specify the mode for handling the quad-link signal: QUADRANT or INTERLEAVE.", + "smithy.api#jsonName": "mode" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.", + "smithy.api#jsonName": "name" + } + }, + "RequestId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "Type": { + "target": "com.amazonaws.medialive#SdiSourceType", + "traits": { + "smithy.api#documentation": "Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to create a SdiSource.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#CreateSdiSourceResponse": { + "type": "structure", + "members": { + "SdiSource": { + "target": "com.amazonaws.medialive#SdiSource", + "traits": { + "smithy.api#documentation": "Settings for the SDI source.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CreateSdiSourceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#CreateSignalMap": { "type": "operation", "input": { @@ -8699,6 +8920,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -8973,6 +9201,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#DeleteSdiSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DeleteSdiSourceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DeleteSdiSourceResponse" + }, + "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": "Delete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prod/sdiSources/{SdiSourceId}", + "code": 202 + } + } + }, + "com.amazonaws.medialive#DeleteSdiSourceRequest": { + "type": "structure", + "members": { + "SdiSourceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of the SdiSource.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteSdiSourceRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DeleteSdiSourceResponse": { + "type": "structure", + "members": { + "SdiSource": { + "target": "com.amazonaws.medialive#SdiSource", + "traits": { + "smithy.api#documentation": "Settings for the SDI source.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DeleteSdiSourceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#DeleteSignalMap": { "type": "operation", "input": { @@ -10636,6 +10940,19 @@ "smithy.api#documentation": "Multicast Input settings.", "smithy.api#jsonName": "multicastSettings" } + }, + "Smpte2110ReceiverGroupSettings": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroupSettings", + "traits": { + "smithy.api#documentation": "Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.", + "smithy.api#jsonName": "smpte2110ReceiverGroupSettings" + } + }, + "SdiSources": { + "target": "com.amazonaws.medialive#InputSdiSources", + "traits": { + "smithy.api#jsonName": "sdiSources" + } } }, "traits": { @@ -11535,6 +11852,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -11621,6 +11945,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -12067,6 +12398,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#DescribeSdiSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#DescribeSdiSourceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#DescribeSdiSourceResponse" + }, + "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" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a SdiSource.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/sdiSources/{SdiSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#DescribeSdiSourceRequest": { + "type": "structure", + "members": { + "SdiSourceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Get details about an SdiSource.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeSdiSourceRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#DescribeSdiSourceResponse": { + "type": "structure", + "members": { + "SdiSource": { + "target": "com.amazonaws.medialive#SdiSource", + "traits": { + "smithy.api#documentation": "Settings for the SDI source.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for DescribeSdiSourceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#DescribeThumbnails": { "type": "operation", "input": { @@ -18923,6 +19327,19 @@ "smithy.api#documentation": "Multicast Input settings.", "smithy.api#jsonName": "multicastSettings" } + }, + "Smpte2110ReceiverGroupSettings": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroupSettings", + "traits": { + "smithy.api#documentation": "Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.", + "smithy.api#jsonName": "smpte2110ReceiverGroupSettings" + } + }, + "SdiSources": { + "target": "com.amazonaws.medialive#InputSdiSources", + "traits": { + "smithy.api#jsonName": "sdiSources" + } } }, "traits": { @@ -19406,6 +19823,13 @@ "smithy.api#documentation": "An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration.", "smithy.api#jsonName": "audioChannelPairs" } + }, + "InputResolution": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Choose the resolution of the Link device's source (HD or UHD). Make sure the resolution matches the current source from the device. This value determines MediaLive resource allocation and billing for this input. Only UHD devices can specify this parameter.", + "smithy.api#jsonName": "inputResolution" + } } }, "traits": { @@ -20091,6 +20515,13 @@ "smithy.api#documentation": "An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow.", "smithy.api#jsonName": "audioChannelPairs" } + }, + "InputResolution": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The resolution of the Link device's source (HD or UHD). This value determines MediaLive resource allocation and billing for this input.", + "smithy.api#jsonName": "inputResolution" + } } }, "traits": { @@ -20461,6 +20892,37 @@ "smithy.api#documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines" } }, + "com.amazonaws.medialive#InputSdiSources": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#__string" + }, + "traits": { + "smithy.api#documentation": "SDI Sources for this Input." + } + }, + "com.amazonaws.medialive#InputSdpLocation": { + "type": "structure", + "members": { + "MediaIndex": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The index of the media stream in the SDP file for one SMPTE 2110 stream.", + "smithy.api#jsonName": "mediaIndex" + } + }, + "SdpUrl": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The URL of the SDP file for one SMPTE 2110 stream.", + "smithy.api#jsonName": "sdpUrl" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the SDP file for one of the SMPTE 2110 streams in a receiver group." + } + }, "com.amazonaws.medialive#InputSecurityGroup": { "type": "structure", "members": { @@ -20918,6 +21380,18 @@ "traits": { "smithy.api#enumValue": "MULTICAST" } + }, + "SMPTE_2110_RECEIVER_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMPTE_2110_RECEIVER_GROUP" + } + }, + "SDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDI" + } } }, "traits": { @@ -22833,6 +23307,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#ListSdiSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListSdiSourcesRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListSdiSourcesResponse" + }, + "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": "List all the SdiSources in the AWS account.", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/sdiSources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SdiSources", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListSdiSourcesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The token to retrieve the next page of results.", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListSdiSourcesRequest", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#ListSdiSourcesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#jsonName": "nextToken" + } + }, + "SdiSources": { + "target": "com.amazonaws.medialive#__listOfSdiSourceSummary", + "traits": { + "smithy.api#jsonName": "sdiSources" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListSdiSourcesResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#ListSignalMaps": { "type": "operation", "input": { @@ -24334,6 +24895,9 @@ { "target": "com.amazonaws.medialive#CreatePartnerInput" }, + { + "target": "com.amazonaws.medialive#CreateSdiSource" + }, { "target": "com.amazonaws.medialive#CreateSignalMap" }, @@ -24385,6 +24949,9 @@ { "target": "com.amazonaws.medialive#DeleteSchedule" }, + { + "target": "com.amazonaws.medialive#DeleteSdiSource" + }, { "target": "com.amazonaws.medialive#DeleteSignalMap" }, @@ -24436,6 +25003,9 @@ { "target": "com.amazonaws.medialive#DescribeSchedule" }, + { + "target": "com.amazonaws.medialive#DescribeSdiSource" + }, { "target": "com.amazonaws.medialive#DescribeThumbnails" }, @@ -24505,6 +25075,9 @@ { "target": "com.amazonaws.medialive#ListReservations" }, + { + "target": "com.amazonaws.medialive#ListSdiSources" + }, { "target": "com.amazonaws.medialive#ListSignalMaps" }, @@ -24612,6 +25185,9 @@ }, { "target": "com.amazonaws.medialive#UpdateReservation" + }, + { + "target": "com.amazonaws.medialive#UpdateSdiSource" } ], "traits": { @@ -30546,6 +31122,260 @@ "smithy.api#documentation": "Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them." } }, + "com.amazonaws.medialive#SdiSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of this SdiSource. It is automatically assigned when the SdiSource is created.", + "smithy.api#jsonName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of the SdiSource. Unique in the AWS account.The ID is the resource-id portion of the ARN.", + "smithy.api#jsonName": "id" + } + }, + "Inputs": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of inputs that are currently using this SDI source. This list will be empty if the SdiSource has just been deleted.", + "smithy.api#jsonName": "inputs" + } + }, + "Mode": { + "target": "com.amazonaws.medialive#SdiSourceMode", + "traits": { + "smithy.api#documentation": "Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.", + "smithy.api#jsonName": "mode" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the SdiSource.", + "smithy.api#jsonName": "name" + } + }, + "State": { + "target": "com.amazonaws.medialive#SdiSourceState", + "traits": { + "smithy.api#documentation": "Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).", + "smithy.api#jsonName": "state" + } + }, + "Type": { + "target": "com.amazonaws.medialive#SdiSourceType", + "traits": { + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in CreateSdiSourceResponse, DeleteSdiSourceResponse, DescribeSdiSourceResponse, ListSdiSourcesResponse, UpdateSdiSourceResponse" + } + }, + "com.amazonaws.medialive#SdiSourceMapping": { + "type": "structure", + "members": { + "CardNumber": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "A number that uniquely identifies the SDI card on the node hardware.", + "smithy.api#jsonName": "cardNumber" + } + }, + "ChannelNumber": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "A number that uniquely identifies a port on the SDI card.", + "smithy.api#jsonName": "channelNumber" + } + }, + "SdiSource": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of the SdiSource to associate with this port on this card. You can use the ListSdiSources operation to discover all the IDs.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in DescribeNodeSummary, DescribeNodeResult." + } + }, + "com.amazonaws.medialive#SdiSourceMappingUpdateRequest": { + "type": "structure", + "members": { + "CardNumber": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "A number that uniquely identifies the SDI card on the node hardware. For information about how physical cards are identified on your node hardware, see the documentation for your node hardware. The numbering always starts at 1.", + "smithy.api#jsonName": "cardNumber" + } + }, + "ChannelNumber": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "A number that uniquely identifies a port on the card. This must be an SDI port (not a timecode port, for example). For information about how ports are identified on physical cards, see the documentation for your node hardware.", + "smithy.api#jsonName": "channelNumber" + } + }, + "SdiSource": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of a SDI source streaming on the given SDI capture card port.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in SdiSourceMappingsUpdateRequest. One SDI source mapping. It connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses. You must specify all three parameters in this object." + } + }, + "com.amazonaws.medialive#SdiSourceMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#SdiSourceMapping" + }, + "traits": { + "smithy.api#documentation": "Used in SdiSourceMappings." + } + }, + "com.amazonaws.medialive#SdiSourceMappingsUpdateRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#SdiSourceMappingUpdateRequest" + }, + "traits": { + "smithy.api#documentation": "Used in the SdiSourceMappingsUpdateRequest, which is a parameter of the UpdateNodeRequest, which is used in the UpdateNodeRequest operation. This means that you create a mapping for an SDI source by updating a Node. You can't create the mapping when you first create the Node." + } + }, + "com.amazonaws.medialive#SdiSourceMode": { + "type": "enum", + "members": { + "QUADRANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUADRANT" + } + }, + "INTERLEAVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERLEAVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest." + } + }, + "com.amazonaws.medialive#SdiSourceState": { + "type": "enum", + "members": { + "IDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDLE" + } + }, + "IN_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_USE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in SdiSource, DescribeNodeRequest, DescribeNodeResult" + } + }, + "com.amazonaws.medialive#SdiSourceSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ARN of this SdiSource. It is automatically assigned when the SdiSource is created.", + "smithy.api#jsonName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of the SdiSource. Unique in the AWS account.The ID is the resource-id portion of the ARN.", + "smithy.api#jsonName": "id" + } + }, + "Inputs": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of inputs that are currently using this SDI source. This list will be empty if the SdiSource has just been deleted.", + "smithy.api#jsonName": "inputs" + } + }, + "Mode": { + "target": "com.amazonaws.medialive#SdiSourceMode", + "traits": { + "smithy.api#documentation": "Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.", + "smithy.api#jsonName": "mode" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the SdiSource.", + "smithy.api#jsonName": "name" + } + }, + "State": { + "target": "com.amazonaws.medialive#SdiSourceState", + "traits": { + "smithy.api#documentation": "Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).", + "smithy.api#jsonName": "state" + } + }, + "Type": { + "target": "com.amazonaws.medialive#SdiSourceType", + "traits": { + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in CreateSdiSourceResponse, DeleteSdiSourceResponse, DescribeSdiSourceResponse, ListSdiSourcesResponse, UpdateSdiSourceResponse" + } + }, + "com.amazonaws.medialive#SdiSourceType": { + "type": "enum", + "members": { + "SINGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE" + } + }, + "QUAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUAD" + } + } + }, + "traits": { + "smithy.api#documentation": "Used in SdiSource, CreateSdiSourceRequest, UpdateSdiSourceRequest." + } + }, "com.amazonaws.medialive#SignalMapMonitorDeploymentStatus": { "type": "enum", "members": { @@ -30946,6 +31776,64 @@ "smithy.api#documentation": "Smpte2038 Data Preference" } }, + "com.amazonaws.medialive#Smpte2110ReceiverGroup": { + "type": "structure", + "members": { + "SdpSettings": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroupSdpSettings", + "traits": { + "smithy.api#documentation": "The single Smpte2110ReceiverGroupSdpSettings that identify the video, audio, and ancillary streams for this receiver group.", + "smithy.api#jsonName": "sdpSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "A receiver group is a collection of video, audio, and ancillary streams that you want to group together and attach to one input." + } + }, + "com.amazonaws.medialive#Smpte2110ReceiverGroupSdpSettings": { + "type": "structure", + "members": { + "AncillarySdps": { + "target": "com.amazonaws.medialive#__listOfInputSdpLocation", + "traits": { + "smithy.api#documentation": "A list of InputSdpLocations. Each item in the list specifies the SDP file and index for one ancillary SMPTE 2110 stream.\nEach stream encapsulates one captions stream (out of any number you can include) or the single SCTE 35 stream that you can include.", + "smithy.api#jsonName": "ancillarySdps" + } + }, + "AudioSdps": { + "target": "com.amazonaws.medialive#__listOfInputSdpLocation", + "traits": { + "smithy.api#documentation": "A list of InputSdpLocations. Each item in the list specifies the SDP file and index for one audio SMPTE 2110 stream.", + "smithy.api#jsonName": "audioSdps" + } + }, + "VideoSdp": { + "target": "com.amazonaws.medialive#InputSdpLocation", + "traits": { + "smithy.api#documentation": "The InputSdpLocation that specifies the SDP file and index for the single video SMPTE 2110 stream for this 2110 input.", + "smithy.api#jsonName": "videoSdp" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the SDP files that describe the SMPTE 2110 streams that go into one SMPTE 2110 receiver group." + } + }, + "com.amazonaws.medialive#Smpte2110ReceiverGroupSettings": { + "type": "structure", + "members": { + "Smpte2110ReceiverGroups": { + "target": "com.amazonaws.medialive#__listOfSmpte2110ReceiverGroup", + "traits": { + "smithy.api#jsonName": "smpte2110ReceiverGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the sources for the SMPTE 2110 Receiver Group input." + } + }, "com.amazonaws.medialive#SmpteTtDestinationSettings": { "type": "structure", "members": {}, @@ -35412,6 +36300,19 @@ "smithy.api#documentation": "Multicast Input settings.", "smithy.api#jsonName": "multicastSettings" } + }, + "Smpte2110ReceiverGroupSettings": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroupSettings", + "traits": { + "smithy.api#documentation": "Include this parameter if the input is a SMPTE 2110 input, to identify the stream sources for this input.", + "smithy.api#jsonName": "smpte2110ReceiverGroupSettings" + } + }, + "SdiSources": { + "target": "com.amazonaws.medialive#InputSdiSources", + "traits": { + "smithy.api#jsonName": "sdiSources" + } } }, "traits": { @@ -35918,6 +36819,13 @@ "smithy.api#documentation": "The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.", "smithy.api#jsonName": "role" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappingsUpdateRequest", + "traits": { + "smithy.api#documentation": "The mappings of a SDI capture card port to a logical SDI data stream", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -35997,6 +36905,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -36151,6 +37066,13 @@ "smithy.api#documentation": "The current state of the Node.", "smithy.api#jsonName": "state" } + }, + "SdiSourceMappings": { + "target": "com.amazonaws.medialive#SdiSourceMappings", + "traits": { + "smithy.api#documentation": "An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.", + "smithy.api#jsonName": "sdiSourceMappings" + } } }, "traits": { @@ -36267,6 +37189,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.medialive#UpdateSdiSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#UpdateSdiSourceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#UpdateSdiSourceResponse" + }, + "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#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Change some of the settings in an SdiSource.", + "smithy.api#http": { + "method": "PUT", + "uri": "/prod/sdiSources/{SdiSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.medialive#UpdateSdiSourceRequest": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.medialive#SdiSourceMode", + "traits": { + "smithy.api#documentation": "Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.", + "smithy.api#jsonName": "mode" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Include this parameter only if you want to change the name of the SdiSource. Specify a name that is unique in the AWS account. We recommend you assign a name that describes the source, for example curling-cameraA. Names are case-sensitive.", + "smithy.api#jsonName": "name" + } + }, + "SdiSourceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID of the SdiSource", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.medialive#SdiSourceType", + "traits": { + "smithy.api#documentation": "Include this parameter only if you want to change the mode. Specify the type of the SDI source: SINGLE: The source is a single-link source. QUAD: The source is one part of a quad-link source.", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to update the SdiSource.", + "smithy.api#input": {} + } + }, + "com.amazonaws.medialive#UpdateSdiSourceResponse": { + "type": "structure", + "members": { + "SdiSource": { + "target": "com.amazonaws.medialive#SdiSource", + "traits": { + "smithy.api#documentation": "Settings for the SDI source.", + "smithy.api#jsonName": "sdiSource" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for UpdateSdiSourceResponse", + "smithy.api#output": {} + } + }, "com.amazonaws.medialive#ValidationError": { "type": "structure", "members": { @@ -37583,6 +38599,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary" } }, + "com.amazonaws.medialive#__listOfCmafIngestCaptionLanguageMapping": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#CmafIngestCaptionLanguageMapping" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfCmafIngestCaptionLanguageMapping" + } + }, "com.amazonaws.medialive#__listOfColorCorrection": { "type": "list", "member": { @@ -37799,6 +38824,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfInputRequestDestinationRoute" } }, + "com.amazonaws.medialive#__listOfInputSdpLocation": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#InputSdpLocation" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfInputSdpLocation" + } + }, "com.amazonaws.medialive#__listOfInputSecurityGroup": { "type": "list", "member": { @@ -38141,6 +39175,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfScte35Descriptor" } }, + "com.amazonaws.medialive#__listOfSdiSourceSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#SdiSourceSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfSdiSourceSummary" + } + }, "com.amazonaws.medialive#__listOfSignalMapSummary": { "type": "list", "member": { @@ -38150,6 +39193,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfSignalMapSummary" } }, + "com.amazonaws.medialive#__listOfSmpte2110ReceiverGroup": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#Smpte2110ReceiverGroup" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfSmpte2110ReceiverGroup" + } + }, "com.amazonaws.medialive#__listOfSrtCallerSource": { "type": "list", "member": { diff --git a/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json b/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json index 0bcd569b..1689aabb 100644 --- a/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json +++ b/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json @@ -436,7 +436,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

\n

For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types\n in Elemental MediaTailor User Guide.

" + "smithy.api#documentation": "

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

\n

For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types\n in Elemental MediaTailor User Guide.

" } }, "com.amazonaws.mediatailor#AdsInteractionPublishOptInEventType": { @@ -1382,8 +1382,7 @@ "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { - "smithy.api#documentation": "

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

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

The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

" } }, "Name": { @@ -1405,8 +1404,19 @@ "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { - "smithy.api#documentation": "

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

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

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

" + } + }, + "RecurringPrefetchConfiguration": { + "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

" + } + }, + "ScheduleType": { + "target": "com.amazonaws.mediatailor#PrefetchScheduleType", + "traits": { + "smithy.api#documentation": "

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

\n

For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.\n

" } }, "StreamId": { @@ -1429,7 +1439,7 @@ "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { - "smithy.api#documentation": "

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

" + "smithy.api#documentation": "

The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

" } }, "Name": { @@ -1450,6 +1460,18 @@ "smithy.api#documentation": "

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

" } }, + "RecurringPrefetchConfiguration": { + "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines how MediaTailor performs recurring prefetch.

" + } + }, + "ScheduleType": { + "target": "com.amazonaws.mediatailor#PrefetchScheduleType", + "traits": { + "smithy.api#documentation": "

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

" + } + }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -3105,7 +3127,7 @@ "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { - "smithy.api#documentation": "

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

" + "smithy.api#documentation": "

The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

" } }, "Name": { @@ -3126,6 +3148,18 @@ "smithy.api#documentation": "

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

" } }, + "ScheduleType": { + "target": "com.amazonaws.mediatailor#PrefetchScheduleType", + "traits": { + "smithy.api#documentation": "

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

" + } + }, + "RecurringPrefetchConfiguration": { + "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

" + } + }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -3519,6 +3553,29 @@ } } }, + "com.amazonaws.mediatailor#ListPrefetchScheduleType": { + "type": "enum", + "members": { + "SINGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE" + } + }, + "RECURRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECURRING" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, "com.amazonaws.mediatailor#ListPrefetchSchedules": { "type": "operation", "input": { @@ -3569,6 +3626,12 @@ "smithy.api#required": {} } }, + "ScheduleType": { + "target": "com.amazonaws.mediatailor#ListPrefetchScheduleType", + "traits": { + "smithy.api#documentation": "

The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING \n indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

" + } + }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -5262,7 +5325,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

" + "smithy.api#documentation": "

For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.

" } }, "com.amazonaws.mediatailor#PrefetchRetrieval": { @@ -5286,6 +5349,18 @@ "traits": { "smithy.api#documentation": "

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

" } + }, + "TrafficShapingType": { + "target": "com.amazonaws.mediatailor#TrafficShapingType", + "traits": { + "smithy.api#documentation": "

Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

" + } + }, + "TrafficShapingRetrievalWindow": { + "target": "com.amazonaws.mediatailor#TrafficShapingRetrievalWindow", + "traits": { + "smithy.api#documentation": "

Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

" + } } }, "traits": { @@ -5305,8 +5380,7 @@ "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { - "smithy.api#documentation": "

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

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

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

" } }, "Name": { @@ -5326,8 +5400,19 @@ "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { - "smithy.api#documentation": "

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

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

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

" + } + }, + "ScheduleType": { + "target": "com.amazonaws.mediatailor#PrefetchScheduleType", + "traits": { + "smithy.api#documentation": "

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

\n

For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.\n

" + } + }, + "RecurringPrefetchConfiguration": { + "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", + "traits": { + "smithy.api#documentation": "

The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

" } }, "StreamId": { @@ -5375,6 +5460,23 @@ "smithy.api#noReplace": {} } }, + "com.amazonaws.mediatailor#PrefetchScheduleType": { + "type": "enum", + "members": { + "SINGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE" + } + }, + "RECURRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECURRING" + } + } + } + }, "com.amazonaws.mediatailor#ProgramResource": { "type": "resource", "identifiers": { @@ -5701,6 +5803,93 @@ } } }, + "com.amazonaws.mediatailor#RecurringConsumption": { + "type": "structure", + "members": { + "RetrievedAdExpirationSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "

The number of seconds that an ad is available for insertion after it was prefetched.

" + } + }, + "AvailMatchingCriteria": { + "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", + "traits": { + "smithy.api#documentation": "

The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.

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

The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.

" + } + }, + "com.amazonaws.mediatailor#RecurringPrefetchConfiguration": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The start time for the window that MediaTailor prefetches and inserts ads in a live event.

" + } + }, + "EndTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The end time for the window that MediaTailor prefetches and inserts ads in a live event.

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

The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.

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

The configuration for prefetch ad retrieval from the ADS.

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

The configuration that defines how MediaTailor performs recurring prefetch.

" + } + }, + "com.amazonaws.mediatailor#RecurringRetrieval": { + "type": "structure", + "members": { + "DynamicVariables": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The dynamic variables to use for substitution during prefetch requests to the ADS.

" + } + }, + "DelayAfterAvailEndSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "

The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).

" + } + }, + "TrafficShapingType": { + "target": "com.amazonaws.mediatailor#TrafficShapingType", + "traits": { + "smithy.api#documentation": "

Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

" + } + }, + "TrafficShapingRetrievalWindow": { + "target": "com.amazonaws.mediatailor#TrafficShapingRetrievalWindow", + "traits": { + "smithy.api#documentation": "

Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

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

With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following\n configurations describe the MediaTailor behavior when prefetching ads for a live event.

" + } + }, "com.amazonaws.mediatailor#RelativePosition": { "type": "enum", "members": { @@ -6402,6 +6591,31 @@ "smithy.api#documentation": "

The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.

\n

The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).

\n

See the time_signal() table of the 2022 SCTE-35 specification for more information.

" } }, + "com.amazonaws.mediatailor#TrafficShapingRetrievalWindow": { + "type": "structure", + "members": { + "RetrievalWindowDurationSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.

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

The configuration that tells Elemental MediaTailor how to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

" + } + }, + "com.amazonaws.mediatailor#TrafficShapingType": { + "type": "enum", + "members": { + "RETRIEVAL_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRIEVAL_WINDOW" + } + } + } + }, "com.amazonaws.mediatailor#Transition": { "type": "structure", "members": { diff --git a/memorydb/service/2021-01-01/memorydb-2021-01-01.json b/memorydb/service/2021-01-01/memorydb-2021-01-01.json index 2ae4ac9e..fe998e50 100644 --- a/memorydb/service/2021-01-01/memorydb-2021-01-01.json +++ b/memorydb/service/2021-01-01/memorydb-2021-01-01.json @@ -1589,6 +1589,18 @@ "traits": { "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. \n This parameter must be set when using r6gd nodes. For more information, see Data tiering.

" } + }, + "NetworkType": { + "target": "com.amazonaws.memorydb#NetworkType", + "traits": { + "smithy.api#documentation": "

The IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.memorydb#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The mechanism that the cluster uses to discover IP addresses. Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.

" + } } }, "traits": { @@ -2188,6 +2200,18 @@ "traits": { "smithy.api#documentation": "

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. \n This parameter must be set when using r6gd nodes. For more information, see Data tiering.

" } + }, + "NetworkType": { + "target": "com.amazonaws.memorydb#NetworkType", + "traits": { + "smithy.api#documentation": "

Specifies the IP address type for the cluster. Valid values are 'ipv4', 'ipv6', or 'dual_stack'. When set to 'ipv4', the cluster will only be accessible via IPv4 addresses. When set to 'ipv6', the cluster will only be accessible via IPv6 addresses. When set to 'dual_stack', the cluster will be accessible via both IPv4 and IPv6 addresses. If not specified, the default is 'ipv4'.

" + } + }, + "IpDiscovery": { + "target": "com.amazonaws.memorydb#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.

" + } } }, "traits": { @@ -2246,7 +2270,7 @@ "MultiRegionClusterNameSuffix": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

A suffix to be added to the multi-Region cluster name.

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

A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with \"virxk\", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

", "smithy.api#required": {} } }, @@ -4732,6 +4756,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.memorydb#IpDiscovery": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, "com.amazonaws.memorydb#KeyList": { "type": "list", "member": { @@ -4910,7 +4951,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags currently on a named resource.\n \n A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. \n For more information, see Tagging your MemoryDB resources.

" + "smithy.api#documentation": "

Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources.

\n

When you add or remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MemoryDB resources.

\n

" } }, "com.amazonaws.memorydb#ListTagsRequest": { @@ -5073,6 +5114,35 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.memorydb#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dual_stack" + } + } + } + }, + "com.amazonaws.memorydb#NetworkTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#NetworkType" + } + }, "com.amazonaws.memorydb#NoOperationFault": { "type": "structure", "members": { @@ -6408,6 +6478,12 @@ "traits": { "smithy.api#documentation": "

The Availability Zone where the subnet resides

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.memorydb#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

The network types supported by this subnet. Returns an array of strings that can include 'ipv4', 'ipv6', or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.

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

The ARN (Amazon Resource Name) of the subnet group.

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.memorydb#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

The network types supported by this subnet group. Returns an array of strings that can include 'ipv4', 'ipv6', or both, indicating the IP address types that can be used for clusters deployed in this subnet group.

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

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. \n\n When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see \n\n Resource-level permissions.

\n

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value \n (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories \n (such as cost centers, application names, or owners) to organize your costs across multiple services.\n \n For more information, see Using Cost Allocation Tags.

" + "smithy.api#documentation": "

Use this operation to add tags to a resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. For more information, see Tagging your MemoryDB resources.

\n

When you add tags to multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MemoryDB resources.

\n

You can specify cost-allocation tags for your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value \n (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories \n (such as cost centers, application names, or owners) to organize your costs across multiple services.\n \n For more information, see Using Cost Allocation Tags.

" } }, "com.amazonaws.memorydb#TagResourceRequest": { @@ -6868,7 +6950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to remove tags on a resource.

" + "smithy.api#documentation": "

Use this operation to remove tags on a resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. For more information, see Tagging your MemoryDB resources.

\n

When you remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MemoryDB resources.

\n

You can specify cost-allocation tags for your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value \n (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories \n (such as cost centers, application names, or owners) to organize your costs across multiple services.\n \n For more information, see Using Cost Allocation Tags.

" } }, "com.amazonaws.memorydb#UntagResourceRequest": { @@ -7138,6 +7220,12 @@ "traits": { "smithy.api#documentation": "

The Access Control List that is associated with the cluster.

" } + }, + "IpDiscovery": { + "target": "com.amazonaws.memorydb#IpDiscovery", + "traits": { + "smithy.api#documentation": "

The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes will return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.

" + } } }, "traits": { @@ -7227,7 +7315,7 @@ "UpdateStrategy": { "target": "com.amazonaws.memorydb#UpdateStrategy", "traits": { - "smithy.api#documentation": "

Whether to force the update even if it may cause data loss.

" + "smithy.api#documentation": "

The strategy to use for the update operation. Supported values are \"coordinated\" or \"uncoordinated\".

" } } }, diff --git a/mq/service/2017-11-27/mq-2017-11-27.json b/mq/service/2017-11-27/mq-2017-11-27.json index b66e5da6..f56ec3cc 100644 --- a/mq/service/2017-11-27/mq-2017-11-27.json +++ b/mq/service/2017-11-27/mq-2017-11-27.json @@ -1265,6 +1265,71 @@ "smithy.api#output": {} } }, + "com.amazonaws.mq#DeleteConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mq#DeleteConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mq#DeleteConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mq#BadRequestException" + }, + { + "target": "com.amazonaws.mq#ConflictException" + }, + { + "target": "com.amazonaws.mq#ForbiddenException" + }, + { + "target": "com.amazonaws.mq#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mq#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/configurations/{ConfigurationId}", + "code": 200 + } + } + }, + "com.amazonaws.mq#DeleteConfigurationRequest": { + "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": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mq#DeleteConfigurationResponse": { + "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#jsonName": "configurationId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mq#DeleteTags": { "type": "operation", "input": { @@ -3977,6 +4042,9 @@ { "target": "com.amazonaws.mq#DeleteBroker" }, + { + "target": "com.amazonaws.mq#DeleteConfiguration" + }, { "target": "com.amazonaws.mq#DeleteTags" }, diff --git a/omics/service/2022-11-28/omics-2022-11-28.json b/omics/service/2022-11-28/omics-2022-11-28.json index 5f8c970a..5db3b4fa 100644 --- a/omics/service/2022-11-28/omics-2022-11-28.json +++ b/omics/service/2022-11-28/omics-2022-11-28.json @@ -431,7 +431,7 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name of the annotation store version. \n

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

The name of the annotation store version.

", "smithy.api#required": {} } }, @@ -479,7 +479,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "

\n The annotation schema generated by the parsed annotation data. \n

" + "smithy.api#documentation": "

The annotation schema generated by the parsed annotation data.

" } } }, @@ -651,83 +651,83 @@ "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe store ID for an annotation store version. \n

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

The store ID for an annotation store version.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe annotation store version ID. \n

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

The annotation store version ID.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version. \n

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

The status of an annotation store version.

", "smithy.api#required": {} } }, "versionArn": { "target": "com.amazonaws.omics#Arn", "traits": { - "smithy.api#documentation": "

\nThe Arn for an annotation store version. \n

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

The Arn for an annotation store version.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "

\nA name given to an annotation store version to distinguish it from others. \n

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

A name given to an annotation store version to distinguish it from others.

", "smithy.api#required": {} } }, "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store version.\n

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

The name of an annotation store version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "

\nThe description of an annotation store version. \n

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

The description of an annotation store version.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was created. \n

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

The time stamp for when an annotation store version was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was updated. \n

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

The time stamp for when an annotation store version was updated.

", "smithy.api#required": {} } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version.\n

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

The status of an annotation store version.

", "smithy.api#required": {} } }, "versionSizeBytes": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

\nThe size of an annotation store version in Bytes. \n

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

The size of an annotation store version in Bytes.

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

\nAnnotation store versions.\n

" + "smithy.api#documentation": "

Annotation store versions.

" } }, "com.amazonaws.omics#AnnotationStoreVersionItems": { @@ -1215,7 +1215,7 @@ "partNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n A number identifying the part in a read set upload.\n

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

A number identifying the part in a read set upload.

", "smithy.api#range": { "min": 1, "max": 10000 @@ -1226,14 +1226,14 @@ "partSource": { "target": "com.amazonaws.omics#ReadSetPartSource", "traits": { - "smithy.api#documentation": "

\n The source file of the part being uploaded. \n

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

The source file of the part being uploaded.

", "smithy.api#required": {} } }, "checksum": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n A unique identifier used to confirm that parts are being added to the correct upload.\n

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

A unique identifier used to confirm that parts are being added to the correct upload.

", "smithy.api#length": { "min": 1, "max": 100 @@ -1244,7 +1244,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Part of the response to the CompleteReadSetUpload API, including metadata.\n

" + "smithy.api#documentation": "

Part of the response to the CompleteReadSetUpload API, including metadata.

" } }, "com.amazonaws.omics#CompletionTime": { @@ -1345,7 +1345,7 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from other versions. \n

" + "smithy.api#documentation": "

The name given to an annotation store version to distinguish it from other versions.

" } }, "sseConfig": { @@ -1417,7 +1417,7 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from other versions. \n

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

The name given to an annotation store version to distinguish it from other versions.

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

\nCreates a new version of an annotation store. \n

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

Creates a new version of an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -1482,7 +1482,7 @@ "name": { "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store version from which versions are being created. \n

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

The name of an annotation store version from which versions are being created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1490,26 +1490,26 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from other versions. \n

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

The name given to an annotation store version to distinguish it from other versions.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "

\nThe description of an annotation store version. \n

" + "smithy.api#documentation": "

The description of an annotation store version.

" } }, "versionOptions": { "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "

\nThe options for an annotation store version. \n

" + "smithy.api#documentation": "

The options for an annotation store version.

" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

\nAny tags added to annotation store version. \n

" + "smithy.api#documentation": "

Any tags added to annotation store version.

" } } }, @@ -1523,48 +1523,48 @@ "id": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nA generated ID for the annotation store \n

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

A generated ID for the annotation store

", "smithy.api#required": {} } }, "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from other versions. \n

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

The name given to an annotation store version to distinguish it from other versions.

", "smithy.api#required": {} } }, "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe ID for the annotation store from which new versions are being created. \n

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

The ID for the annotation store from which new versions are being created.

", "smithy.api#required": {} } }, "versionOptions": { "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "

\nThe options for an annotation store version. \n

" + "smithy.api#documentation": "

The options for an annotation store version.

" } }, "name": { "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from other versions. \n

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

The name given to an annotation store version to distinguish it from other versions.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "

\nThe status of a annotation store version. \n

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

The status of a annotation store version.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for the creation of an annotation store version. \n

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

The time stamp for the creation of an annotation store version.

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

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. \n Subsequent runs use the task outputs from the cache, rather than computing the task outputs again.\n You specify an Amazon S3 location where HealthOmics saves the cached data. This data must be \n immediately accessible (not in an archived state).

\n

For more information, see Creating a run cache in the AWS HealthOmics User Guide.

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

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).

For more information, see Creating a run cache in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -1958,13 +1958,13 @@ "cacheBehavior": { "target": "com.amazonaws.omics#CacheBehavior", "traits": { - "smithy.api#documentation": "

Default cache behavior for runs that use this cache. Supported values are:

\n

\n CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is \n useful if you're debugging a workflow that fails after several\n tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition,\n inputs, and container in ECR are identical to the prior run.

\n

\n CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting\n is useful in development mode, but do not use it in a production setting.

\n

If you don't specify a value, the default behavior is CACHE_ON_FAILURE.\n When you start a run that uses this cache, you can override the default cache behavior.

\n

For more information, see Run cache behavior in the AWS HealthOmics User Guide.

" + "smithy.api#documentation": "

Default cache behavior for runs that use this cache. Supported values are:

CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" } }, "cacheS3Location": { "target": "com.amazonaws.omics#S3UriForBucketOrObject", "traits": { - "smithy.api#documentation": "

Specify the S3 location for storing the cached task outputs.\n This data must be immediately accessible (not in an archived state).

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

Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

", "smithy.api#required": {} } }, @@ -1983,7 +1983,7 @@ "requestId": { "target": "com.amazonaws.omics#RunCacheRequestId", "traits": { - "smithy.api#documentation": "

A unique request token, to ensure idempotency. If you don't specify a token, \n HealthOmics automatically generates a universally unique identifier (UUID) for the request.

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

A unique request token, to ensure idempotency. If you don't specify a token, Amazon Web Services HealthOmics automatically generates a universally unique identifier (UUID) for the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1997,7 +1997,7 @@ "cacheBucketOwnerId": { "target": "com.amazonaws.omics#AwsAccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the expected owner of the S3 bucket for the run cache.\n If not provided, your account ID is set as the owner of the bucket.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.

" } } }, @@ -2095,7 +2095,7 @@ "maxCpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of CPUs that can run\n concurrently across all active runs in the run group.

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

The maximum number of CPUs that can run concurrently across all active runs in the run group.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -2115,7 +2115,7 @@ "maxDuration": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum time for each run (in minutes). If a run exceeds\n the maximum run time, the run fails automatically.

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

The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -2139,7 +2139,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of GPUs that can run concurrently across all active\n runs in the run group.

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

The maximum number of GPUs that can run concurrently across all active runs in the run group.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -2257,7 +2257,7 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload.

" } @@ -2329,7 +2329,7 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload.

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

Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).

\n

The following resources support cross-account sharing:

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

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -2625,7 +2625,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a workflow.

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

Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:

For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -2654,7 +2654,7 @@ "engine": { "target": "com.amazonaws.omics#WorkflowEngine", "traits": { - "smithy.api#documentation": "

An engine for the workflow.

" + "smithy.api#documentation": "

The workflow engine for the workflow.

" } }, "definitionZip": { @@ -2685,7 +2685,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The default storage capacity for the workflow runs, in gibibytes.

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -2711,6 +2711,12 @@ "traits": { "smithy.api#documentation": "

The computational accelerator specified to run the workflow.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

" + } } }, "traits": { @@ -2743,6 +2749,206 @@ "traits": { "smithy.api#documentation": "

The workflow's tags.

" } + }, + "uuid": { + "target": "com.amazonaws.omics#WorkflowUuid", + "traits": { + "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#CreateWorkflowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#CreateWorkflowVersionRequest" + }, + "output": { + "target": "com.amazonaws.omics#CreateWorkflowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don\u2019t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "workflows-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workflow/{workflowId}/version", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#CreateWorkflowVersionRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The ID of the workflow where you are creating the new version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "id" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

", + "smithy.api#required": {} + } + }, + "definitionZip": { + "target": "smithy.api#Blob", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A zip archive containing the workflow definition for this workflow version.

" + } + }, + "definitionUri": { + "target": "com.amazonaws.omics#WorkflowDefinition", + "traits": { + "smithy.api#documentation": "

The URI specifies the location of the workflow definition for this workflow version.

" + } + }, + "accelerators": { + "target": "com.amazonaws.omics#Accelerators", + "traits": { + "smithy.api#documentation": "

The computational accelerator for this workflow version.

" + } + }, + "description": { + "target": "com.amazonaws.omics#WorkflowVersionDescription", + "traits": { + "smithy.api#documentation": "

A description for this workflow version.

" + } + }, + "engine": { + "target": "com.amazonaws.omics#WorkflowEngine", + "traits": { + "smithy.api#documentation": "

The workflow engine for this workflow version.

" + } + }, + "main": { + "target": "com.amazonaws.omics#WorkflowMain", + "traits": { + "smithy.api#documentation": "

The path of the main definition file for this workflow version.

" + } + }, + "parameterTemplate": { + "target": "com.amazonaws.omics#WorkflowParameterTemplate", + "traits": { + "smithy.api#documentation": "

The parameter template defines the input parameters for runs that use this workflow version.

" + } + }, + "requestId": { + "target": "com.amazonaws.omics#WorkflowRequestId", + "traits": { + "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique ID for each request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "tags": { + "target": "com.amazonaws.omics#TagMap", + "traits": { + "smithy.api#documentation": "

Optional tags to associate with this workflow version.

" + } + }, + "workflowBucketOwnerId": { + "target": "com.amazonaws.omics#WorkflowBucketOwnerId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#CreateWorkflowVersionResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.omics#WorkflowVersionArn", + "traits": { + "smithy.api#documentation": "

ARN of the workflow version.

" + } + }, + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The workflow version name.

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

The workflow version status.

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

The workflow version's tags.

" + } + }, + "uuid": { + "target": "com.amazonaws.omics#WorkflowUuid", + "traits": { + "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow version.

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

\nDeletes one or multiple versions of an annotation store. \n

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

Deletes one or multiple versions of an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -2910,7 +3116,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name of the annotation store from which versions are being deleted. \n

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

The name of the annotation store from which versions are being deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2918,7 +3124,7 @@ "versions": { "target": "com.amazonaws.omics#VersionList", "traits": { - "smithy.api#documentation": "

\nThe versions of an annotation store to be deleted. \n

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

The versions of an annotation store to be deleted.

", "smithy.api#required": {} } }, @@ -2926,7 +3132,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

\nForces the deletion of an annotation store version when imports are in-progress.. \n

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

Forces the deletion of an annotation store version when imports are in-progress..

", "smithy.api#httpQuery": "force" } } @@ -2941,7 +3147,7 @@ "errors": { "target": "com.amazonaws.omics#VersionDeleteErrorList", "traits": { - "smithy.api#documentation": "

\nAny errors that occur when attempting to delete an annotation store version. \n

" + "smithy.api#documentation": "

Any errors that occur when attempting to delete an annotation store version.

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

Delete a run cache. This action removes the cache metadata stored in the service account, \n but doesn't delete the data in Amazon S3. \n You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. \n You can remove old cache data using standard S3 Delete operations.\n

\n

For more information, see Deleting a run cache in the AWS HealthOmics User Guide.

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

Delete a run cache. This action removes the cache metadata stored in the service account, but doesn't delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations.

For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -3451,7 +3657,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a resource share. If you are the resource owner, the subscriber will no longer have \n access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

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

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -3639,6 +3845,78 @@ "smithy.api#input": {} } }, + "com.amazonaws.omics#DeleteWorkflowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteWorkflowVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "workflows-" + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workflow/{workflowId}/version/{versionName}", + "code": 202 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteWorkflowVersionRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "id" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The workflow version name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.omics#Description": { "type": "string", "traits": { @@ -3934,6 +4212,12 @@ "target": "com.amazonaws.omics#ExportReadSet" } }, + "com.amazonaws.omics#FallbackLocation": { + "type": "string", + "traits": { + "smithy.api#pattern": "^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?$" + } + }, "com.amazonaws.omics#FileInformation": { "type": "structure", "members": { @@ -4024,7 +4308,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use filters to return a subset of resources. You can define filters for specific parameters,\n such as the resource status.

" + "smithy.api#documentation": "

Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.

" } }, "com.amazonaws.omics#FormatOptions": { @@ -4236,7 +4520,7 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name of the annotation store version. \n

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

The name of the annotation store version.

", "smithy.api#required": {} } }, @@ -4555,7 +4839,7 @@ "numVersions": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\nAn integer indicating how many versions of an annotation store exist. \n

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

An integer indicating how many versions of an annotation store exist.

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

\nRetrieves the metadata for an annotation store version. \n

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

Retrieves the metadata for an annotation store version.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -4690,7 +4974,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from others. \n

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

The name given to an annotation store version to distinguish it from others.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4698,7 +4982,7 @@ "versionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from others. \n

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

The name given to an annotation store version to distinguish it from others.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4714,90 +4998,90 @@ "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe store ID for annotation store version.\n

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

The store ID for annotation store version.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe annotation store version ID.\n

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

The annotation store version ID.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version. \n

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

The status of an annotation store version.

", "smithy.api#required": {} } }, "versionArn": { "target": "com.amazonaws.omics#Arn", "traits": { - "smithy.api#documentation": "

\nThe Arn for the annotation store. \n

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

The Arn for the annotation store.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "

\nThe name of the annotation store. \n

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

The name of the annotation store.

", "smithy.api#required": {} } }, "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version to distinguish it from others. \n

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

The name given to an annotation store version to distinguish it from others.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "

\nThe description for an annotation store version. \n

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

The description for an annotation store version.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was created. \n

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

The time stamp for when an annotation store version was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was updated. \n

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

The time stamp for when an annotation store version was updated.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

\nAny tags associated with an annotation store version. \n

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

Any tags associated with an annotation store version.

", "smithy.api#required": {} } }, "versionOptions": { "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "

\nThe options for an annotation store version. \n

" + "smithy.api#documentation": "

The options for an annotation store version.

" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version.\n

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

The status of an annotation store version.

", "smithy.api#required": {} } }, "versionSizeBytes": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

\nThe size of the annotation store version in Bytes. \n

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

The size of the annotation store version in Bytes.

", "smithy.api#required": {} } } @@ -5631,7 +5915,7 @@ "creationType": { "target": "com.amazonaws.omics#CreationType", "traits": { - "smithy.api#documentation": "

\n The creation type of the read set.\n

" + "smithy.api#documentation": "

The creation type of the read set.

" } }, "etag": { @@ -6325,7 +6609,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow run.

\n

If a workflow is shared with you, you cannot export information about the run.

\n

HealthOmics stores a fixed number of runs that are available to the console and API. If \n GetRun doesn't return the requested run, you can find run logs \n for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs \n in the AWS HealthOmics User Guide.

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

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6498,7 +6782,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve the details for the specified run cache.

\n

For more information, see Call caching for HealthOmics runs in the AWS HealthOmics User Guide.

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

Retrieve the details for the specified run cache.

For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6788,7 +7072,7 @@ "engineVersion": { "target": "com.amazonaws.omics#EngineVersion", "traits": { - "smithy.api#documentation": "

The workflow engine version.

" + "smithy.api#documentation": "

The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.

" } }, "status": { @@ -6864,7 +7148,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.

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

The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -6972,6 +7256,18 @@ "traits": { "smithy.api#documentation": "

The ID of the workflow owner.

" } + }, + "workflowVersionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The workflow version name.

" + } + }, + "workflowUuid": { + "target": "com.amazonaws.omics#WorkflowUuid", + "traits": { + "smithy.api#documentation": "

The universally unique identifier (UUID) value for the workflow.

" + } } }, "traits": { @@ -7208,7 +7504,7 @@ "cacheHit": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Set to true if AWS HealthOmics found a matching entry in the run cache for this task.

" + "smithy.api#documentation": "

Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.

" } }, "cacheS3Uri": { @@ -7359,7 +7655,7 @@ "storeId": { "target": "com.amazonaws.omics#StoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated Sequence Store or Reference Store ID.

" + "smithy.api#documentation": "

The Amazon Web Services-generated Sequence Store or Reference Store ID.

" } }, "storeType": { @@ -7489,7 +7785,7 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload.

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

Gets information about a workflow.

\n

If a workflow is shared with you, you cannot export the workflow.

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

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -8245,7 +8541,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The workflow's default run storage capacity in gibibytes.

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -8274,7 +8570,7 @@ "metadata": { "target": "com.amazonaws.omics#WorkflowMetadata", "traits": { - "smithy.api#documentation": "

Gets metadata for workflow.

" + "smithy.api#documentation": "

Gets metadata for the workflow.

" } }, "accelerators": { @@ -8282,6 +8578,295 @@ "traits": { "smithy.api#documentation": "

The computational accelerator specified to run the workflow.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for runs using this workflow.

" + } + }, + "uuid": { + "target": "com.amazonaws.omics#WorkflowUuid", + "traits": { + "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#GetWorkflowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetWorkflowVersionRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetWorkflowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "workflows-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workflow/{workflowId}/version/{versionName}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "WorkflowVersionActive": { + "documentation": "Wait until a workflow version is active.", + "minDelay": 3, + "maxDelay": 30, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "UPDATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.omics#GetWorkflowVersionRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "id" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The workflow version name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.omics#WorkflowType", + "traits": { + "smithy.api#documentation": "

The workflow's type.

", + "smithy.api#httpQuery": "type" + } + }, + "export": { + "target": "com.amazonaws.omics#WorkflowExportList", + "traits": { + "smithy.api#documentation": "

The export format for the workflow.

", + "smithy.api#httpQuery": "export" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Id of the owner of the workflow.

", + "smithy.api#httpQuery": "workflowOwnerId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetWorkflowVersionResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.omics#WorkflowVersionArn", + "traits": { + "smithy.api#documentation": "

ARN of the workflow version.

" + } + }, + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The workflow version name.

" + } + }, + "accelerators": { + "target": "com.amazonaws.omics#Accelerators", + "traits": { + "smithy.api#documentation": "

The accelerator for this workflow version.

" + } + }, + "creationTime": { + "target": "com.amazonaws.omics#WorkflowTimestamp", + "traits": { + "smithy.api#documentation": "

When the workflow version was created.

" + } + }, + "description": { + "target": "com.amazonaws.omics#WorkflowVersionDescription", + "traits": { + "smithy.api#documentation": "

Description of the workflow version.

" + } + }, + "definition": { + "target": "com.amazonaws.omics#WorkflowDefinition", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Definition of the workflow version.

" + } + }, + "digest": { + "target": "com.amazonaws.omics#WorkflowDigest", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The workflow version's digest.

" + } + }, + "engine": { + "target": "com.amazonaws.omics#WorkflowEngine", + "traits": { + "smithy.api#documentation": "

The workflow engine for this workflow version.

" + } + }, + "main": { + "target": "com.amazonaws.omics#WorkflowMain", + "traits": { + "smithy.api#documentation": "

The path of the main definition file for the workflow.

" + } + }, + "metadata": { + "target": "com.amazonaws.omics#WorkflowMetadata", + "traits": { + "smithy.api#documentation": "

The metadata for the workflow version.

" + } + }, + "parameterTemplate": { + "target": "com.amazonaws.omics#WorkflowParameterTemplate", + "traits": { + "smithy.api#documentation": "

The parameter template for the workflow version.

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

The workflow version status

" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#WorkflowStatusMessage", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The workflow version status message

" + } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for the run.

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

The default run storage capacity for static storage.

", + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "type": { + "target": "com.amazonaws.omics#WorkflowType", + "traits": { + "smithy.api#documentation": "

The workflow version type

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

The workflow version tags

" + } + }, + "uuid": { + "target": "com.amazonaws.omics#WorkflowUuid", + "traits": { + "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow version

" + } + }, + "workflowBucketOwnerId": { + "target": "com.amazonaws.omics#WorkflowBucketOwnerId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Id of the owner of the bucket.

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

\nLists the versions of an annotation store. \n

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

Lists the versions of an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -8889,7 +9474,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use filters to focus the returned annotation store versions on a specific parameter,\n such as the status of the annotation store.

" + "smithy.api#documentation": "

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

" } }, "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { @@ -8898,7 +9483,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store. \n

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

The name of an annotation store.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8906,7 +9491,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\nThe maximum number of annotation store versions to return in one page of results.\n

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

The maximum number of annotation store versions to return in one page of results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -8917,7 +9502,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n

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

Specifies the pagination token from a previous request to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1, @@ -8928,7 +9513,7 @@ "filter": { "target": "com.amazonaws.omics#ListAnnotationStoreVersionsFilter", "traits": { - "smithy.api#documentation": "

\nA filter to apply to the list of annotation store versions.\n

" + "smithy.api#documentation": "

A filter to apply to the list of annotation store versions.

" } } }, @@ -8942,13 +9527,13 @@ "annotationStoreVersions": { "target": "com.amazonaws.omics#AnnotationStoreVersionItems", "traits": { - "smithy.api#documentation": "

\nLists all versions of an annotation store.\n

" + "smithy.api#documentation": "

Lists all versions of an annotation store.

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

\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n

" + "smithy.api#documentation": "

Specifies the pagination token from a previous request to retrieve the next page of results.

" } } }, @@ -9119,7 +9704,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list multipart read set uploads", - "smithy.api#documentation": "

Lists multipart read set uploads and for in progress uploads. \n Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

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

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -9161,7 +9746,7 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "

Next token returned in the response of a previous ListMultipartReadSetUploads call. \n Used to get the next page of results.

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

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -9176,7 +9761,7 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "

Next token returned in the response of a previous ListMultipartReadSetUploads call. \n Used to get the next page of results.

" + "smithy.api#documentation": "

Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

" } }, "uploads": { @@ -9604,7 +10189,7 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "

Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.

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

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9625,7 +10210,7 @@ "nextToken": { "target": "com.amazonaws.omics#NextToken", "traits": { - "smithy.api#documentation": "

Next token returned in the response of a previous ListReadSetUploadParts call.\n Used to get the next page of results.

" + "smithy.api#documentation": "

Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

" } }, "parts": { @@ -10150,7 +10735,7 @@ "nextToken": { "target": "com.amazonaws.omics#ListToken", "traits": { - "smithy.api#documentation": "

Pagination token to retrieve additional run caches. If the response does not have a \n nextTokenvalue, you have reached to the end of the list.

" + "smithy.api#documentation": "

Pagination token to retrieve additional run caches. If the response does not have a nextTokenvalue, you have reached to the end of the list.

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

Retrieves a list of runs.

\n

HealthOmics stores a fixed number of runs that are available to the console and API. If \n the ListRuns response doesn't include specific runs that you expected, you can find run logs \n for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs \n in the AWS HealthOmics User Guide.

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

Retrieves a list of runs.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -10627,7 +11212,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the resource shares associated with an account. Use the filter parameter to \n retrieve a specific subset of the shares.

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

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -10664,7 +11249,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.

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

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10693,7 +11278,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nNext token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.\n

" + "smithy.api#documentation": "

Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

" } } }, @@ -11008,17 +11593,139 @@ "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "nextToken", - "smithy.api#length": { - "min": 1, - "max": 10000 - } + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "filter": { + "target": "com.amazonaws.omics#ListVariantStoresFilter", + "traits": { + "smithy.api#documentation": "

A filter to apply to the list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#ListVariantStoresResponse": { + "type": "structure", + "members": { + "variantStores": { + "target": "com.amazonaws.omics#VariantStoreItems", + "traits": { + "smithy.api#documentation": "

A list of variant stores.

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

A pagination token that's included if more results are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#ListWorkflowVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#ListWorkflowVersionsRequest" + }, + "output": { + "target": "com.amazonaws.omics#ListWorkflowVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "workflows-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workflow/{workflowId}/version", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startingToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#ListWorkflowVersionsRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "id" + } + }, + "type": { + "target": "com.amazonaws.omics#WorkflowType", + "traits": { + "smithy.api#documentation": "

The workflow type.

", + "smithy.api#httpQuery": "type" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "

Amazon Web Services Id of the owner of the workflow.

", + "smithy.api#httpQuery": "workflowOwnerId" + } + }, + "startingToken": { + "target": "com.amazonaws.omics#WorkflowVersionListToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "startingToken" } }, - "filter": { - "target": "com.amazonaws.omics#ListVariantStoresFilter", + "maxResults": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A filter to apply to the list.

" + "smithy.api#documentation": "

The maximum number of workflows to return in one page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } } } }, @@ -11026,17 +11733,17 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#ListVariantStoresResponse": { + "com.amazonaws.omics#ListWorkflowVersionsResponse": { "type": "structure", "members": { - "variantStores": { - "target": "com.amazonaws.omics#VariantStoreItems", + "items": { + "target": "com.amazonaws.omics#WorkflowVersionList", "traits": { - "smithy.api#documentation": "

A list of variant stores.

" + "smithy.api#documentation": "

A list of workflow version items.

" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#WorkflowVersionListToken", "traits": { "smithy.api#documentation": "

A pagination token that's included if more results are available.

" } @@ -11181,81 +11888,81 @@ "sequenceStoreId": { "target": "com.amazonaws.omics#SequenceStoreId", "traits": { - "smithy.api#documentation": "

\n The sequence store ID used for the multipart upload.\n

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

The sequence store ID used for the multipart upload.

", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.omics#UploadId", "traits": { - "smithy.api#documentation": "

\n The ID for the initiated multipart upload.\n

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

The ID for the initiated multipart upload.

", "smithy.api#required": {} } }, "sourceFileType": { "target": "com.amazonaws.omics#FileType", "traits": { - "smithy.api#documentation": "

\n The type of file the read set originated from.\n

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

The type of file the read set originated from.

", "smithy.api#required": {} } }, "subjectId": { "target": "com.amazonaws.omics#SubjectId", "traits": { - "smithy.api#documentation": "

\n The read set source's subject ID.\n

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

The read set source's subject ID.

", "smithy.api#required": {} } }, "sampleId": { "target": "com.amazonaws.omics#SampleId", "traits": { - "smithy.api#documentation": "

\n The read set source's sample ID.\n

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

The read set source's sample ID.

", "smithy.api#required": {} } }, "generatedFrom": { "target": "com.amazonaws.omics#GeneratedFrom", "traits": { - "smithy.api#documentation": "

\n The source of an uploaded part.\n

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

The source of an uploaded part.

", "smithy.api#required": {} } }, "referenceArn": { "target": "com.amazonaws.omics#ReferenceArn", "traits": { - "smithy.api#documentation": "

\n The source's reference ARN.\n

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

The source's reference ARN.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#ReadSetName", "traits": { - "smithy.api#documentation": "

\n The name of a read set. \n

" + "smithy.api#documentation": "

The name of a read set.

" } }, "description": { "target": "com.amazonaws.omics#ReadSetDescription", "traits": { - "smithy.api#documentation": "

\n The description of a read set. \n

" + "smithy.api#documentation": "

The description of a read set.

" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

\n Any tags you wish to add to a read set. \n

" + "smithy.api#documentation": "

Any tags you wish to add to a read set.

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

\n The time stamp for when a direct upload was created.\n

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

The time stamp for when a direct upload was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } } }, "traits": { - "smithy.api#documentation": "

\n Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.\n

" + "smithy.api#documentation": "

Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.

" } }, "com.amazonaws.omics#NextToken": { @@ -11279,7 +11986,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The operation is not supported by Amazon Omics, or the API does not exist. \n

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

The operation is not supported by Amazon Omics, or the API does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 405 } @@ -11382,7 +12089,7 @@ "FederatedUser" ], "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the\n AWS HealthOmics User Guide.

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

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

", "smithy.api#title": "Amazon Omics", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -12142,7 +12849,7 @@ "storeId": { "target": "com.amazonaws.omics#StoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated Sequence Store or Reference Store ID.

" + "smithy.api#documentation": "

The Amazon Web Services-generated Sequence Store or Reference Store ID.

" } }, "storeType": { @@ -12517,25 +13224,25 @@ "sampleId": { "target": "com.amazonaws.omics#SampleId", "traits": { - "smithy.api#documentation": "

\n The read set source's sample ID.\n

" + "smithy.api#documentation": "

The read set source's sample ID.

" } }, "subjectId": { "target": "com.amazonaws.omics#SubjectId", "traits": { - "smithy.api#documentation": "

\n The read set source's subject ID.\n

" + "smithy.api#documentation": "

The read set source's subject ID.

" } }, "generatedFrom": { "target": "com.amazonaws.omics#GeneratedFrom", "traits": { - "smithy.api#documentation": "

\n Where the source originated.\n

" + "smithy.api#documentation": "

Where the source originated.

" } }, "creationType": { "target": "com.amazonaws.omics#CreationType", "traits": { - "smithy.api#documentation": "

\n The creation type of the read set.\n

" + "smithy.api#documentation": "

The creation type of the read set.

" } } }, @@ -12711,13 +13418,13 @@ "statusMessage": { "target": "com.amazonaws.omics#ReadSetStatusMessage", "traits": { - "smithy.api#documentation": "

\n The status for a read set. It provides more detail as to why the read set has a status. \n

" + "smithy.api#documentation": "

The status for a read set. It provides more detail as to why the read set has a status.

" } }, "creationType": { "target": "com.amazonaws.omics#CreationType", "traits": { - "smithy.api#documentation": "

\n The creation type of the read set.\n

" + "smithy.api#documentation": "

The creation type of the read set.

" } }, "etag": { @@ -12883,20 +13590,20 @@ "createdAfter": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

\n Filters for read set uploads after a specified time.\n

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

Filters for read set uploads after a specified time.

", "smithy.api#timestampFormat": "date-time" } }, "createdBefore": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

\n Filters for read set part uploads before a specified time.\n

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

Filters for read set part uploads before a specified time.

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

\n Filter settings that select for read set upload parts of interest.\n

" + "smithy.api#documentation": "

Filter settings that select for read set upload parts of interest.

" } }, "com.amazonaws.omics#ReadSetUploadPartListItem": { @@ -12905,7 +13612,7 @@ "partNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n The number identifying the part in an upload. \n

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

The number identifying the part in an upload.

", "smithy.api#range": { "min": 1, "max": 10000 @@ -12916,7 +13623,7 @@ "partSize": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

\n The size of the the part in an upload.\n

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

The size of the the part in an upload.

", "smithy.api#range": { "min": 1, "max": 5368709120 @@ -12927,34 +13634,34 @@ "partSource": { "target": "com.amazonaws.omics#ReadSetPartSource", "traits": { - "smithy.api#documentation": "

\n The origin of the part being direct uploaded.\n

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

The origin of the part being direct uploaded.

", "smithy.api#required": {} } }, "checksum": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n A unique identifier used to confirm that parts are being added to the correct upload.\n

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

A unique identifier used to confirm that parts are being added to the correct upload.

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time stamp for when a direct upload was created.\n

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

The time stamp for when a direct upload was created.

", "smithy.api#timestampFormat": "date-time" } }, "lastUpdatedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time stamp for the most recent update to an uploaded part. \n

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

The time stamp for the most recent update to an uploaded part.

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

\n The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.\n

" + "smithy.api#documentation": "

The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

" } }, "com.amazonaws.omics#ReferenceArn": { @@ -13835,7 +14542,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n The maximum GPUs that can be used by a run group. \n

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

The maximum GPUs that can be used by a run group.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -13989,7 +14696,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.

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

The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -14019,6 +14726,12 @@ "traits": { "smithy.api#documentation": "

The run's storage type.

" } + }, + "workflowVersionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The name of the workflow version.

" + } } }, "traits": { @@ -14524,9 +15237,9 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { - "smithy.api#documentation": "

\n An S3 location that is used to store files that have failed a direct upload. \n

" + "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload.

" } }, "eTagAlgorithmFamily": { @@ -15083,7 +15796,7 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name of the annotation store version. \n

" + "smithy.api#documentation": "

The name of the annotation store version.

" } }, "formatOptions": { @@ -15158,7 +15871,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set activation job from the given Sequence Store", - "smithy.api#documentation": "

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read\n sets after 30 days.

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

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -15794,7 +16507,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.

\n

StartRun will not support re-run for a workflow that is shared with you.

\n

HealthOmics stores a fixed number of runs that are available to the console and API.\n By default, HealthOmics doesn't any remove any runs. If HealthOmics reaches the maximum \n number of runs, you must manually remove runs. To have older runs removed automatically,\n set the retention mode to REMOVE.

\n

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. \n You can set the storage type to DYNAMIC. You do not set storageCapacity,\n because HealthOmics dynamically scales the storage up or down as required.\n For more information about static and dynamic storage, see Running workflows \n in the AWS HealthOmics User Guide.

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

Starts a new run or duplicates an existing run.

For a new run, specify a unique requestId, the workflowId, and a role ARN. If you're using static run storage (the default), specify the required storageCapacity.

You duplicate a run by specifing a unique requestId, the runID of the run to duplicate, and a role ARN.

For more information about the optional parameters in the StartRun request, see Starting a run in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -15842,13 +16555,13 @@ "cacheId": { "target": "com.amazonaws.omics#NumericIdInArn", "traits": { - "smithy.api#documentation": "

Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached \n for this run.

" + "smithy.api#documentation": "

Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

" } }, "cacheBehavior": { "target": "com.amazonaws.omics#CacheBehavior", "traits": { - "smithy.api#documentation": "

The cache behavior for the run. You specify this value if you want to override\n the default behavior for the cache. You had set the default value when you created the cache.\n For more information, see Run cache behavior in the AWS HealthOmics User Guide.

" + "smithy.api#documentation": "

The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" } }, "runGroupId": { @@ -15876,7 +16589,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic\n (the system ignores any value that you enter).

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

The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

", "smithy.api#range": { "min": 0, "max": 100000 @@ -15912,13 +16625,13 @@ "retentionMode": { "target": "com.amazonaws.omics#RunRetentionMode", "traits": { - "smithy.api#documentation": "

The retention mode for the run. The default value is RETAIN.

\n

HealthOmics stores a fixed number of runs that are available to the console and API. \n In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum.\n If you set the retention mode to REMOVE, HealthOmics automatically \n removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum.\n All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

\n

For more information about retention mode, see Specifying run retention mode \n in the AWS HealthOmics User Guide.

" + "smithy.api#documentation": "

The retention mode for the run. The default value is RETAIN.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

" } }, "storageType": { "target": "com.amazonaws.omics#StorageType", "traits": { - "smithy.api#documentation": "

The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage.\n If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up \n or down, based on file system utilization.

" + "smithy.api#documentation": "

The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

" } }, "workflowOwnerId": { @@ -15926,6 +16639,12 @@ "traits": { "smithy.api#documentation": "

The ID of the workflow owner.

" } + }, + "workflowVersionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The name of the workflow version.

" + } } }, "traits": { @@ -16448,7 +17167,7 @@ "cacheHit": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Set to true if AWS HealthOmics found a matching entry in the run cache for this task.

" + "smithy.api#documentation": "

Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.

" } }, "cacheS3Uri": { @@ -16487,7 +17206,7 @@ "gpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n The number of Graphics Processing Units (GPU) specified for the task. \n

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

The number of Graphics Processing Units (GPU) specified for the task.

", "smithy.api#range": { "min": 0 } @@ -16669,19 +17388,19 @@ "annotationType": { "target": "com.amazonaws.omics#AnnotationType", "traits": { - "smithy.api#documentation": "

\nThe store version's annotation type.\n

" + "smithy.api#documentation": "

The store version's annotation type.

" } }, "formatToHeader": { "target": "com.amazonaws.omics#FormatToHeader", "traits": { - "smithy.api#documentation": "

\nThe annotation store version's header key to column name mapping.\n

" + "smithy.api#documentation": "

The annotation store version's header key to column name mapping.

" } }, "schema": { "target": "com.amazonaws.omics#Schema", "traits": { - "smithy.api#documentation": "

\nThe TSV schema for an annotation store version. \n

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

The TSV schema for an annotation store version.

", "smithy.api#length": { "min": 1, "max": 5000 @@ -16690,7 +17409,7 @@ } }, "traits": { - "smithy.api#documentation": "

\nThe options for a TSV file.\n

" + "smithy.api#documentation": "

The options for a TSV file.

" } }, "com.amazonaws.omics#TypeList": { @@ -16941,7 +17660,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nUpdates the description of an annotation store version. \n

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

Updates the description of an annotation store version.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -16958,7 +17677,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store. \n

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

The name of an annotation store.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16966,7 +17685,7 @@ "versionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store version. \n

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

The name of an annotation store version.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16974,7 +17693,7 @@ "description": { "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "

\nThe description of an annotation store. \n

" + "smithy.api#documentation": "

The description of an annotation store.

" } } }, @@ -16988,56 +17707,56 @@ "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe annotation store ID. \n

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

The annotation store ID.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "

\nThe annotation store version ID.\n

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

The annotation store version ID.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version. \n

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

The status of an annotation store version.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store. \n

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

The name of an annotation store.

", "smithy.api#required": {} } }, "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name of an annotation store version.

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

The name of an annotation store version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "

\nThe description of an annotation store version.\n

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

The description of an annotation store version.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was created. \n

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

The time stamp for when an annotation store version was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "

\nThe time stamp for when an annotation store version was updated. \n

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

The time stamp for when an annotation store version was updated.

", "smithy.api#required": {} } } @@ -17308,7 +18027,7 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { "smithy.api#documentation": "

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

" } @@ -17396,7 +18115,7 @@ } }, "fallbackLocation": { - "target": "com.amazonaws.omics#S3Destination", + "target": "com.amazonaws.omics#FallbackLocation", "traits": { "smithy.api#documentation": "

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

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

Updates a workflow.

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

Updates information about a workflow. For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -17608,6 +18327,115 @@ "traits": { "smithy.api#documentation": "

A description for the workflow.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#UpdateWorkflowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#UpdateWorkflowVersionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "workflows-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workflow/{workflowId}/version/{versionName}", + "code": 202 + } + } + }, + "com.amazonaws.omics#UpdateWorkflowVersionRequest": { + "type": "structure", + "members": { + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "id" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The name of the workflow version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#WorkflowVersionDescription", + "traits": { + "smithy.api#documentation": "

Description of the workflow version.

" + } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } } }, "traits": { @@ -17661,7 +18489,7 @@ "traits": { "aws.auth#unsignedPayload": {}, "aws.iam#actionPermissionDescription": "Grants permission to upload read set parts", - "smithy.api#documentation": "

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, \n the previously uploaded part will be overwritten.

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

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -17920,7 +18748,7 @@ "annotationFields": { "target": "com.amazonaws.omics#AnnotationFieldMap", "traits": { - "smithy.api#documentation": "

\n The annotation schema generated by the parsed annotation data. \n

" + "smithy.api#documentation": "

The annotation schema generated by the parsed annotation data.

" } } }, @@ -18077,20 +18905,20 @@ "versionName": { "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "

\nThe name given to an annotation store version.\n

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

The name given to an annotation store version.

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

\nThe message explaining the error in annotation store deletion.\n

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

The message explaining the error in annotation store deletion.

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

\nThe error preventing deletion of the annotation store version. \n

" + "smithy.api#documentation": "

The error preventing deletion of the annotation store version.

" } }, "com.amazonaws.omics#VersionDeleteErrorList": { @@ -18127,12 +18955,12 @@ "tsvVersionOptions": { "target": "com.amazonaws.omics#TsvVersionOptions", "traits": { - "smithy.api#documentation": "

\nFile settings for a version of a TSV store.\n

" + "smithy.api#documentation": "

File settings for a version of a TSV store.

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

\nThe options for an annotation store version. \n

" + "smithy.api#documentation": "

The options for an annotation store version.

" } }, "com.amazonaws.omics#VersionStatus": { @@ -18177,6 +19005,12 @@ "smithy.api#pattern": "^arn:.+$" } }, + "com.amazonaws.omics#WorkflowBucketOwnerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.omics#WorkflowDefinition": { "type": "string", "traits": { @@ -18320,7 +19154,7 @@ "metadata": { "target": "com.amazonaws.omics#WorkflowMetadata", "traits": { - "smithy.api#documentation": "

\n Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return. \n

" + "smithy.api#documentation": "

Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

" } } }, @@ -18478,6 +19312,11 @@ "list": { "target": "com.amazonaws.omics#ListWorkflows" }, + "resources": [ + { + "target": "com.amazonaws.omics#WorkflowVersion" + } + ], "traits": { "aws.api#arn": { "template": "workflow/{id}" @@ -18559,6 +19398,155 @@ "max": 64 } } + }, + "com.amazonaws.omics#WorkflowUuid": { + "type": "string", + "traits": { + "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.omics#WorkflowVersion": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.omics#WorkflowId" + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName" + } + }, + "put": { + "target": "com.amazonaws.omics#CreateWorkflowVersion" + }, + "read": { + "target": "com.amazonaws.omics#GetWorkflowVersion" + }, + "update": { + "target": "com.amazonaws.omics#UpdateWorkflowVersion" + }, + "delete": { + "target": "com.amazonaws.omics#DeleteWorkflowVersion" + }, + "list": { + "target": "com.amazonaws.omics#ListWorkflowVersions" + }, + "traits": { + "aws.api#arn": { + "template": "workflow/{id}/version/{versionName}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.omics#WorkflowVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:.+$" + } + }, + "com.amazonaws.omics#WorkflowVersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#WorkflowVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#WorkflowVersionListItem" + } + }, + "com.amazonaws.omics#WorkflowVersionListItem": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.omics#WorkflowVersionArn", + "traits": { + "smithy.api#documentation": "

ARN of the workflow version.

" + } + }, + "workflowId": { + "target": "com.amazonaws.omics#WorkflowId", + "traits": { + "smithy.api#documentation": "

The workflow's ID.

" + } + }, + "versionName": { + "target": "com.amazonaws.omics#WorkflowVersionName", + "traits": { + "smithy.api#documentation": "

The name of the workflow version.

" + } + }, + "description": { + "target": "com.amazonaws.omics#WorkflowVersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the workflow version.

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

The status of the workflow version.

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

The type of the workflow version.

" + } + }, + "digest": { + "target": "com.amazonaws.omics#WorkflowDigest", + "traits": { + "smithy.api#documentation": "

The digist of the workflow version.

" + } + }, + "creationTime": { + "target": "com.amazonaws.omics#WorkflowTimestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the workflow version.

" + } + }, + "metadata": { + "target": "com.amazonaws.omics#WorkflowMetadata", + "traits": { + "smithy.api#documentation": "

Metadata for the workflow version.

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

A list of workflow version items.

" + } + }, + "com.amazonaws.omics#WorkflowVersionListToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#WorkflowVersionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-\\._]*$" + } } } } \ No newline at end of file diff --git a/opensearch/service/2021-01-01/opensearch-2021-01-01.json b/opensearch/service/2021-01-01/opensearch-2021-01-01.json index 6fa4d1dd..a2f09daa 100644 --- a/opensearch/service/2021-01-01/opensearch-2021-01-01.json +++ b/opensearch/service/2021-01-01/opensearch-2021-01-01.json @@ -2044,18 +2044,18 @@ "key": { "target": "com.amazonaws.opensearch#AppConfigType", "traits": { - "smithy.api#documentation": "

Specify the item to configure, such as admin role for the OpenSearch Application.

" + "smithy.api#documentation": "

The configuration item to set, such as the admin role for the OpenSearch application.

" } }, "value": { "target": "com.amazonaws.opensearch#AppConfigValue", "traits": { - "smithy.api#documentation": "

Specifies the value to configure for the key, such as an IAM user ARN.

" + "smithy.api#documentation": "

The value assigned to the configuration key, such as an IAM user ARN.

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

Configurations of the OpenSearch Application.

" + "smithy.api#documentation": "

Configuration settings for an OpenSearch application. For more information, see \n see Using the OpenSearch user interface in Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AppConfigType": { @@ -2159,7 +2159,7 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier for an OpenSearch application.

" + "smithy.api#documentation": "

The unique identifier of an OpenSearch application.

" } }, "arn": { @@ -2168,36 +2168,36 @@ "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { - "smithy.api#documentation": "

Name of an OpenSearch Application.

" + "smithy.api#documentation": "

The name of an OpenSearch application.

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

Endpoint URL of an OpenSearch Application.

" + "smithy.api#documentation": "

The endpoint URL of an OpenSearch application.

" } }, "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { - "smithy.api#documentation": "

Status of an OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" + "smithy.api#documentation": "

The current status of an OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which an OpenSearch Application was created.

" + "smithy.api#documentation": "

The timestamp when an OpenSearch application was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which an OpenSearch Application was last updated.

" + "smithy.api#documentation": "

The timestamp of the last update to an OpenSearch application.

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

Basic information of the OpenSearch Application.

" + "smithy.api#documentation": "

Basic details of an OpenSearch application.

" } }, "com.amazonaws.opensearch#AssociatePackage": { @@ -3646,7 +3646,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an OpenSearch Application.

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

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application", @@ -3660,33 +3660,33 @@ "clientToken": { "target": "com.amazonaws.opensearch#ClientToken", "traits": { - "smithy.api#documentation": "

A unique client idempotency token. It will be auto generated if not provided.

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

Unique, case-sensitive identifier to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { - "smithy.api#documentation": "

Name of the OpenSearch Appication to create. Application names are unique across the applications\n owned by an account within an Amazon Web Services Region.

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

The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account.

", "smithy.api#required": {} } }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { - "smithy.api#documentation": "

Data sources to be associated with the OpenSearch Application.

" + "smithy.api#documentation": "

The data sources to link to the OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptionsInput", "traits": { - "smithy.api#documentation": "

Settings of IAM Identity Center for the OpenSearch Application.

" + "smithy.api#documentation": "

Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configurations of the OpenSearch Application, inlcuding admin configuration.

" + "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative options.

" } }, "tagList": { @@ -3703,13 +3703,13 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier for the created OpenSearch Application.

" + "smithy.api#documentation": "

The unique identifier assigned to the OpenSearch application.

" } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { - "smithy.api#documentation": "

Name of the created OpenSearch Application.

" + "smithy.api#documentation": "

The name of the OpenSearch application.

" } }, "arn": { @@ -3718,19 +3718,19 @@ "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { - "smithy.api#documentation": "

Data sources associated with the created OpenSearch Application.

" + "smithy.api#documentation": "

The data sources linked to the OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { - "smithy.api#documentation": "

Settings of IAM Identity Center for the created OpenSearch Application.

" + "smithy.api#documentation": "

The IAM Identity Center settings configured for the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configurations of the OpenSearch Application, inlcuding admin configuration.

" + "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative options.

" } }, "tagList": { @@ -3739,7 +3739,7 @@ "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp when the OpenSearch Application was created.

" + "smithy.api#documentation": "

The timestamp indicating when the OpenSearch application was created.

" } } }, @@ -3884,7 +3884,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput", "traits": { - "smithy.api#documentation": "

Options for IAM Identity Center Option control for the domain.

" + "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a domain.

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

Deletes an existing OpenSearch Application.

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

Deletes a specified OpenSearch application.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/application/{id}", @@ -4431,7 +4431,7 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier for the OpenSearch Application that you want to delete.

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

The unique identifier of the OpenSearch application to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6626,7 +6626,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsStatus", "traits": { - "smithy.api#documentation": "

Container for IAM Identity Center Option control for the domain.

" + "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a domain.

" } }, "AutoTuneOptions": { @@ -6916,7 +6916,7 @@ "NodeType": { "target": "com.amazonaws.opensearch#NodeType", "traits": { - "smithy.api#documentation": "

Indicates whether the nodes is a data, master, or ultrawarm node.

" + "smithy.api#documentation": "

Indicates whether the nodes is a data, master, or UltraWarm node.

" } }, "AvailabilityZone": { @@ -6946,7 +6946,7 @@ "StorageVolumeType": { "target": "com.amazonaws.opensearch#VolumeType", "traits": { - "smithy.api#documentation": "

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable\n for data nodes.

" + "smithy.api#documentation": "

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable\n for data nodes.

" } }, "StorageSize": { @@ -7320,7 +7320,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { - "smithy.api#documentation": "

Container for IAM Identity Center Option control for the domain.

" + "smithy.api#documentation": "

Configuration options for controlling IAM Identity Center integration within a domain.

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

Check the configuration and status of an existing OpenSearch Application.

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

Retrieves the configuration and status of an existing OpenSearch application.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/application/{id}", @@ -7765,7 +7765,7 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier of the checked OpenSearch Application.

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

The unique identifier of the OpenSearch application to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7781,7 +7781,7 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier of the checked OpenSearch Application.

" + "smithy.api#documentation": "

The unique identifier of the OpenSearch application.

" } }, "arn": { @@ -7790,49 +7790,49 @@ "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { - "smithy.api#documentation": "

Name of the checked OpenSearch Application.

" + "smithy.api#documentation": "

The name of the OpenSearch application.

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

Endpoint URL of the checked OpenSearch Application.

" + "smithy.api#documentation": "

The endpoint URL of the OpenSearch application.

" } }, "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { - "smithy.api#documentation": "

Current status of the checked OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" + "smithy.api#documentation": "

The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { - "smithy.api#documentation": "

IAM Identity Center settings for the checked OpenSearch Application.

" + "smithy.api#documentation": "

The IAM Identity Center settings configured for the OpenSearch application.

" } }, "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { - "smithy.api#documentation": "

Associated data sources to the checked OpenSearch Application.

" + "smithy.api#documentation": "

The data sources associated with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

App configurations of the checked OpenSearch Application.

" + "smithy.api#documentation": "

The configuration settings of the OpenSearch application.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which the checked OpenSearch Application was created.

" + "smithy.api#documentation": "

The timestamp when the OpenSearch application was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which the checked OpenSearch Application was last updated.

" + "smithy.api#documentation": "

The timestamp of the last update to the OpenSearch application.

" } } }, @@ -8507,7 +8507,7 @@ "enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

IAM Identity Center is enabled for the OpenSearch Application.

" + "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for the OpenSearch Application.

" } }, "iamIdentityCenterInstanceArn": { @@ -8516,7 +8516,7 @@ "iamRoleForIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch Application.

" } }, "iamIdentityCenterApplicationArn": { @@ -8524,7 +8524,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings for IAM Identity Center for an OpenSearch Application.

" + "smithy.api#documentation": "

Configuration settings for IAM Identity Center in an OpenSearch Application.

" } }, "com.amazonaws.opensearch#IamIdentityCenterOptionsInput": { @@ -8533,7 +8533,7 @@ "enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Enable/disable settings for IAM Identity Center.

" + "smithy.api#documentation": "

Specifies whether IAM Identity Center is enabled or disabled.

" } }, "iamIdentityCenterInstanceArn": { @@ -8542,12 +8542,12 @@ "iamRoleForIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name of IAM Identity Center's application.

" + "smithy.api#documentation": "

The ARN of the IAM role associated with the IAM Identity Center application.

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

Settings for IAM Identity Center.

" + "smithy.api#documentation": "

Configuration settings for enabling and managing IAM Identity Center.

" } }, "com.amazonaws.opensearch#Id": { @@ -8582,42 +8582,42 @@ "EnabledAPIAccess": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

" + "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for the application.

" } }, "IdentityCenterInstanceARN": { "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { - "smithy.api#documentation": "

The ARN for IAM Identity Center Instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center

" + "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

" } }, "IdentityCenterApplicationARN": { "target": "com.amazonaws.opensearch#IdentityCenterApplicationARN", "traits": { - "smithy.api#documentation": "

The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

" } }, "IdentityStoreId": { "target": "com.amazonaws.opensearch#IdentityStoreId", "traits": { - "smithy.api#documentation": "

The ID of IAM Identity Store.

" + "smithy.api#documentation": "

The identifier of the IAM Identity Store.

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

Container for IAM Identity Center Options settings.

" + "smithy.api#documentation": "

Settings container for integrating IAM Identity Center with OpenSearch UI applications, \n which enables enabling secure user authentication and access control across multiple data sources.\n This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

" } }, "com.amazonaws.opensearch#IdentityCenterOptionsInput": { @@ -8626,30 +8626,30 @@ "EnabledAPIAccess": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

" + "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.

" } }, "IdentityCenterInstanceARN": { "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { - "smithy.api#documentation": "

The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center

" + "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

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

Container for IAM Identity Center Options settings.

" + "smithy.api#documentation": "

Configuration settings for enabling and managing IAM Identity Center.

" } }, "com.amazonaws.opensearch#IdentityCenterOptionsStatus": { @@ -8658,20 +8658,20 @@ "Options": { "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { - "smithy.api#documentation": "

Container for IAM Identity Center Options settings.

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

Configuration settings for IAM Identity Center integration.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { - "smithy.api#documentation": "

The status of IAM Identity Center Options settings for a domain.

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

The status of IAM Identity Center configuration settings for a domain.

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

The status of IAM Identity Center Options settings for a domain.

" + "smithy.api#documentation": "

The status of IAM Identity Center configuration settings for a domain.

" } }, "com.amazonaws.opensearch#IdentityPoolId": { @@ -9223,7 +9223,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all OpenSearch Applications under your account.

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

Lists all OpenSearch applications under your account.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/list-applications", @@ -9249,7 +9249,7 @@ "statuses": { "target": "com.amazonaws.opensearch#ApplicationStatuses", "traits": { - "smithy.api#documentation": "

OpenSearch Application Status can be used as filters for the listing request. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

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

Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

", "smithy.api#httpQuery": "statuses" } }, @@ -9271,7 +9271,7 @@ "ApplicationSummaries": { "target": "com.amazonaws.opensearch#ApplicationSummaries", "traits": { - "smithy.api#documentation": "

Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.

" + "smithy.api#documentation": "

Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.

" } }, "nextToken": { @@ -10697,24 +10697,24 @@ "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

A boolean that indicates whether a particular node type is enabled or not.

" + "smithy.api#documentation": "

A boolean value indicating whether a specific node type is active or inactive.

" } }, "Type": { "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", "traits": { - "smithy.api#documentation": "

The instance type of a particular node type in the cluster.

" + "smithy.api#documentation": "

The instance type of a particular node within the cluster.

" } }, "Count": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { - "smithy.api#documentation": "

The number of nodes of a particular node type in the cluster.

" + "smithy.api#documentation": "

The number of nodes of a specific type within the cluster.

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

Container for specifying configuration of any node type.

" + "smithy.api#documentation": "

Configuration options for defining the setup of any node type within the cluster.

" } }, "com.amazonaws.opensearch#NodeId": { @@ -10732,18 +10732,18 @@ "NodeType": { "target": "com.amazonaws.opensearch#NodeOptionsNodeType", "traits": { - "smithy.api#documentation": "

Container for node type like coordinating.

" + "smithy.api#documentation": "

Defines the type of node, such as coordinating nodes.

" } }, "NodeConfig": { "target": "com.amazonaws.opensearch#NodeConfig", "traits": { - "smithy.api#documentation": "

Container for specifying configuration of any node type.

" + "smithy.api#documentation": "

Configuration options for defining the setup of any node type.

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

Container for specifying node type.

" + "smithy.api#documentation": "

Configuration settings for defining the node type within a cluster.

" } }, "com.amazonaws.opensearch#NodeOptionsList": { @@ -11965,7 +11965,7 @@ "PackageOwner": { "target": "com.amazonaws.opensearch#PackageOwner", "traits": { - "smithy.api#documentation": "

The owner of the package who is allowed to create/update a package and add users to the package scope.

" + "smithy.api#documentation": "

The owner of the package who is allowed to create and update a package and add users to the package scope.

" } }, "PackageVendingOptions": { @@ -11977,7 +11977,7 @@ "PackageEncryptionOptions": { "target": "com.amazonaws.opensearch#PackageEncryptionOptions", "traits": { - "smithy.api#documentation": "

Package Encryption Options for a package.

" + "smithy.api#documentation": "

Encryption options for a package.

" } } }, @@ -11998,7 +11998,7 @@ "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { - "smithy.api#documentation": "

List of package IDs that must be associated with the domain with or before the package can be associated.

" + "smithy.api#documentation": "

List of package IDs that must be linked to the domain before or simultaneously with the package association.

" } }, "AssociationConfiguration": { @@ -12030,13 +12030,13 @@ "KmsKeyIdentifier": { "target": "com.amazonaws.opensearch#KmsKeyId", "traits": { - "smithy.api#documentation": "

KMS key ID for encrypting the package.

" + "smithy.api#documentation": "

KMS key ID for encrypting the package.

" } }, "EncryptionEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

This indicates whether encryption is enabled for the package.

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

Whether encryption is enabled for the package.

", "smithy.api#required": {} } } @@ -12223,13 +12223,13 @@ "VendingEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

This indicates whether vending is enabled for the package to determine if package can be used by other users.\n

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

Indicates whether the package vending feature is enabled, allowing the package to be used by other users.

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

The vending options for a package to determine if the package can be used by other users.\n

" + "smithy.api#documentation": "

Configuration options for determining whether a package can be made available for use by other users.

" } }, "com.amazonaws.opensearch#PackageVersion": { @@ -14019,7 +14019,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update the OpenSearch Application.

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

Updates the configuration and settings of an existing OpenSearch application.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/application/{id}", @@ -14033,7 +14033,7 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier of the OpenSearch Application to be updated.

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

The unique identifier for the OpenSearch application to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14041,13 +14041,13 @@ "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { - "smithy.api#documentation": "

Data sources to be associated with the OpenSearch Application.

" + "smithy.api#documentation": "

The data sources to associate with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configurations to be changed for the OpenSearch Application.

" + "smithy.api#documentation": "

The configuration settings to modify for the OpenSearch application.

" } } }, @@ -14061,13 +14061,13 @@ "id": { "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "

Unique identifier of the updated OpenSearch Application.

" + "smithy.api#documentation": "

The unique identifier of the updated OpenSearch application.

" } }, "name": { "target": "com.amazonaws.opensearch#ApplicationName", "traits": { - "smithy.api#documentation": "

Name of the updated OpenSearch Application.

" + "smithy.api#documentation": "

The name of the updated OpenSearch application.

" } }, "arn": { @@ -14076,31 +14076,31 @@ "dataSources": { "target": "com.amazonaws.opensearch#DataSources", "traits": { - "smithy.api#documentation": "

Data sources associated with the updated OpenSearch Application.

" + "smithy.api#documentation": "

The data sources associated with the updated OpenSearch application.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", "traits": { - "smithy.api#documentation": "

IAM Identity Center settings for the updated OpenSearch Application.

" + "smithy.api#documentation": "

The IAM Identity Center configuration for the updated OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configurations for the updated OpenSearch Application.

" + "smithy.api#documentation": "

The configuration settings for the updated OpenSearch application.

" } }, "createdAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which the OpenSearch Application was created.

" + "smithy.api#documentation": "

The timestamp when the OpenSearch application was originally created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.opensearch#Timestamp", "traits": { - "smithy.api#documentation": "

Timestamp at which the OpenSearch Application was last updated.

" + "smithy.api#documentation": "

The timestamp when the OpenSearch application was last updated.

" } } }, diff --git a/outposts/service/2019-12-03/outposts-2019-12-03.json b/outposts/service/2019-12-03/outposts-2019-12-03.json index 3811d407..0d3ec6f4 100644 --- a/outposts/service/2019-12-03/outposts-2019-12-03.json +++ b/outposts/service/2019-12-03/outposts-2019-12-03.json @@ -252,6 +252,16 @@ "smithy.api#pattern": "^(\\w+)$" } }, + "com.amazonaws.outposts#AssetIdInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^\\d{10}$" + } + }, "com.amazonaws.outposts#AssetIdList": { "type": "list", "member": { @@ -264,7 +274,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" } }, "RackId": { @@ -314,7 +324,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" } }, "AccountId": { @@ -788,6 +798,12 @@ "smithy.api#documentation": "

The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

" } }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + } + }, "CapacityTaskStatus": { "target": "com.amazonaws.outposts#CapacityTaskStatus", "traits": { @@ -1670,6 +1686,12 @@ "smithy.api#documentation": "

ID of the Amazon Web Services Outposts order associated with the specified capacity task.

" } }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + } + }, "RequestedInstancePools": { "target": "com.amazonaws.outposts#RequestedInstancePools", "traits": { @@ -1692,7 +1714,7 @@ "CapacityTaskStatus": { "target": "com.amazonaws.outposts#CapacityTaskStatus", "traits": { - "smithy.api#documentation": "

Status of the capacity task.

\n

A capacity task can have one of the following statuses:

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

Status of the capacity task.

\n

A capacity task can have one of the following statuses:

\n " } }, "Failed": { @@ -2111,6 +2133,13 @@ "smithy.api#httpQuery": "OrderId" } }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetIdInput", + "traits": { + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

", + "smithy.api#httpQuery": "AssetId" + } + }, "MaxResults": { "target": "com.amazonaws.outposts#MaxResults1000", "traits": { @@ -2528,7 +2557,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" } }, "MacAddressList": { @@ -5624,6 +5653,12 @@ "smithy.api#documentation": "

The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

" } }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetIdInput", + "traits": { + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + } + }, "InstancePools": { "target": "com.amazonaws.outposts#RequestedInstancePools", "traits": { @@ -5676,6 +5711,12 @@ "smithy.api#documentation": "

ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

" } }, + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + } + }, "RequestedInstancePools": { "target": "com.amazonaws.outposts#RequestedInstancePools", "traits": { @@ -5779,7 +5820,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the Outpost server.

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

The ID of the Outpost server.

", "smithy.api#required": {} } }, @@ -6415,7 +6456,7 @@ "PowerConnector": { "target": "com.amazonaws.outposts#PowerConnector", "traits": { - "smithy.api#documentation": "

The power connector that Amazon Web Services should plan to provide for connections to the hardware.\n Note the correlation between PowerPhase and PowerConnector.

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

The power connector that Amazon Web Services should plan to provide for connections to the hardware.\n Note the correlation between PowerPhase and PowerConnector.

\n " } }, "PowerFeedDrop": { diff --git a/pcs/service/2023-02-10/pcs-2023-02-10.json b/pcs/service/2023-02-10/pcs-2023-02-10.json index 6644c14c..dd79792e 100644 --- a/pcs/service/2023-02-10/pcs-2023-02-10.json +++ b/pcs/service/2023-02-10/pcs-2023-02-10.json @@ -858,7 +858,7 @@ "com.amazonaws.pcs#ClusterIdentifier": { "type": "string", "traits": { - "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{3,40})$" + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,40})$" } }, "com.amazonaws.pcs#ClusterList": { @@ -1213,7 +1213,7 @@ "com.amazonaws.pcs#ComputeNodeGroupIdentifier": { "type": "string", "traits": { - "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{3,25})$" + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,25})$" } }, "com.amazonaws.pcs#ComputeNodeGroupList": { @@ -2937,7 +2937,7 @@ "com.amazonaws.pcs#QueueIdentifier": { "type": "string", "traits": { - "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{3,25})$" + "smithy.api#pattern": "^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,25})$" } }, "com.amazonaws.pcs#QueueList": { @@ -3310,7 +3310,7 @@ "version": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

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

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.\n For more information, see Slurm versions in\n Amazon Web Services PCS in the Amazon Web Services PCS User Guide.

\n

Valid Values: 23.11 | 24.05\n

", "smithy.api#required": {} } } @@ -3332,7 +3332,7 @@ "version": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

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

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.\n For more information, see Slurm versions in\n Amazon Web Services PCS in the Amazon Web Services PCS User Guide.

\n

Valid Values: 23.11 | 24.05\n

", "smithy.api#required": {} } } diff --git a/personalize/service/2018-05-22/personalize-2018-05-22.json b/personalize/service/2018-05-22/personalize-2018-05-22.json index 173df9be..2ce2907e 100644 --- a/personalize/service/2018-05-22/personalize-2018-05-22.json +++ b/personalize/service/2018-05-22/personalize-2018-05-22.json @@ -1851,7 +1851,8 @@ "smithy.api#length": { "min": 0, "max": 150 - } + }, + "smithy.api#pattern": "^[A-Za-z_][A-Za-z\\d_]*$" } }, "com.amazonaws.personalize#ColumnNamesList": { @@ -4295,7 +4296,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\n CREATE PENDING or IN PROGRESS state. For more information about deleting datasets,\n see Deleting a dataset.\n

", "smithy.api#idempotent": {} } }, @@ -5517,6 +5518,44 @@ "com.amazonaws.personalize#ErrorMessage": { "type": "string" }, + "com.amazonaws.personalize#EventParameters": { + "type": "structure", + "members": { + "eventType": { + "target": "com.amazonaws.personalize#EventType", + "traits": { + "smithy.api#documentation": "

The name of the event type to be considered for solution creation.

" + } + }, + "eventValueThreshold": { + "target": "com.amazonaws.personalize#EventTypeThresholdValue", + "traits": { + "smithy.api#documentation": "

The threshold of the event type. Only events with a value greater or equal to this threshold will be considered for solution creation.

" + } + }, + "weight": { + "target": "com.amazonaws.personalize#EventTypeWeight", + "traits": { + "smithy.api#documentation": "

The weight of the event type. A higher weight means higher importance of the event type for the created solution.

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

Describes the parameters of events, which are used in solution creation.

" + } + }, + "com.amazonaws.personalize#EventParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.personalize#EventParameters" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.personalize#EventTracker": { "type": "structure", "members": { @@ -5632,6 +5671,18 @@ } } }, + "com.amazonaws.personalize#EventTypeThresholdValue": { + "type": "double" + }, + "com.amazonaws.personalize#EventTypeWeight": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.personalize#EventValueThreshold": { "type": "string", "traits": { @@ -5641,6 +5692,20 @@ } } }, + "com.amazonaws.personalize#EventsConfig": { + "type": "structure", + "members": { + "eventParametersList": { + "target": "com.amazonaws.personalize#EventParametersList", + "traits": { + "smithy.api#documentation": "

A list of event parameters, which includes event types and their event value thresholds and weights.

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

Describes the configuration of events, which are used in solution creation.

" + } + }, "com.amazonaws.personalize#ExcludedDatasetColumns": { "type": "map", "key": { @@ -8447,6 +8512,12 @@ "smithy.api#documentation": "

The AutoMLConfig object containing a list of recipes to search\n when AutoML is performed.

" } }, + "eventsConfig": { + "target": "com.amazonaws.personalize#EventsConfig", + "traits": { + "smithy.api#documentation": "

Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.

" + } + }, "optimizationObjective": { "target": "com.amazonaws.personalize#OptimizationObjective", "traits": { @@ -8519,6 +8590,12 @@ "members": { "autoTrainingConfig": { "target": "com.amazonaws.personalize#AutoTrainingConfig" + }, + "eventsConfig": { + "target": "com.amazonaws.personalize#EventsConfig", + "traits": { + "smithy.api#documentation": "

Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.

" + } } }, "traits": { @@ -8938,7 +9015,8 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.personalize#TagKeys": { @@ -9018,7 +9096,8 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.personalize#Tags": { diff --git a/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json b/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json index 2db126f9..2a66f7ff 100644 --- a/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json +++ b/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json @@ -7,18 +7,18 @@ "payload": { "target": "com.amazonaws.qbusiness#Payload", "traits": { - "smithy.api#documentation": "

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.\n

" + "smithy.api#documentation": "

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

" } }, "s3": { "target": "com.amazonaws.qbusiness#S3", "traits": { - "smithy.api#documentation": "

Contains details about the S3 object containing the OpenAPI schema for a custom\n plugin. The schema could be in either JSON or YAML format.

" + "smithy.api#documentation": "

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

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

Contains details about the OpenAPI schema for a custom plugin. For more information,\n see custom plugin OpenAPI schemas. You can either include\n the schema directly in the payload field or you can upload it to an S3 bucket and\n specify the S3 bucket location in the s3 field.

" + "smithy.api#documentation": "

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

" } }, "com.amazonaws.qbusiness#APISchemaType": { @@ -59,7 +59,7 @@ "principals": { "target": "com.amazonaws.qbusiness#Principals", "traits": { - "smithy.api#documentation": "

Contains a list of principals, where a principal can be either a USER or\n a GROUP. Each principal can be have the following type of document access:\n ALLOW or DENY.

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

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

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

A list of principals. Each principal can be either a USER or a\n GROUP and can be designated document access permissions of either\n ALLOW or DENY.

" + "smithy.api#documentation": "

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

" } }, "com.amazonaws.qbusiness#AccessControls": { @@ -91,7 +91,7 @@ } }, "traits": { - "smithy.api#documentation": "

You don't have access to perform this action. Make sure you have the required\n permission policies and user accounts and try again.

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

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -142,20 +142,20 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionExecutionPayload", "traits": { - "smithy.api#documentation": "

A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.

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

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

", "smithy.api#required": {} } }, "payloadFieldNameSeparator": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", "traits": { - "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n execution event payload.

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

A string used to retain information about the hierarchical contexts within an action execution event payload.

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

Performs an Amazon Q Business plugin action during a non-streaming chat\n conversation.

" + "smithy.api#documentation": "

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

" } }, "com.amazonaws.qbusiness#ActionExecutionEvent": { @@ -171,20 +171,20 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionExecutionPayload", "traits": { - "smithy.api#documentation": "

A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.

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

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

", "smithy.api#required": {} } }, "payloadFieldNameSeparator": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", "traits": { - "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within a action\n execution event payload.

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

A string used to retain information about the hierarchical contexts within a action execution event payload.

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

A request from an end user signalling an intent to perform an Amazon Q Business plugin\n action during a streaming chat.

" + "smithy.api#documentation": "

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

" } }, "com.amazonaws.qbusiness#ActionExecutionPayload": { @@ -292,18 +292,18 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionReviewPayload", "traits": { - "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.

" + "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" } }, "payloadFieldNameSeparator": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", "traits": { - "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n review payload.

" + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action review payload.

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

An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q Business.

" + "smithy.api#documentation": "

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

" } }, "com.amazonaws.qbusiness#ActionReviewEvent": { @@ -312,7 +312,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "

The identifier of the conversation with which the action review event is\n associated.

" + "smithy.api#documentation": "

The identifier of the conversation with which the action review event is associated.

" } }, "userMessageId": { @@ -324,7 +324,7 @@ "systemMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated associated with the action review\n event.

" + "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated associated with the action review event.

" } }, "pluginId": { @@ -342,18 +342,18 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionReviewPayload", "traits": { - "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.

" + "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" } }, "payloadFieldNameSeparator": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", "traits": { - "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n review event payload.

" + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action review event payload.

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

An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a streaming chat conversation. It contains information about the selected\n action with a list of possible user input fields, some pre-populated by Amazon Q Business.\n

" + "smithy.api#documentation": "

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

" } }, "com.amazonaws.qbusiness#ActionReviewPayload": { @@ -383,7 +383,7 @@ "displayDescription": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "

The field level description of each action review input field. This could be an\n explanation of the field. In the Amazon Q Business web experience, these descriptions could\n be used to display as tool tips to help users understand the field.

" + "smithy.api#documentation": "

The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

" } }, "type": { @@ -401,19 +401,19 @@ "allowedValues": { "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues", "traits": { - "smithy.api#documentation": "

Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" + "smithy.api#documentation": "

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

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

The expected data format for the action review input field value. For example, in PTO\n request, from and to would be of datetime allowed\n format.

" + "smithy.api#documentation": "

The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

" } }, "arrayItemJsonSchema": { "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldArrayItemJsonSchema", "traits": { - "smithy.api#documentation": "

Use to create a custom form with array fields (fields with nested objects inside an\n array).

" + "smithy.api#documentation": "

Use to create a custom form with array fields (fields with nested objects inside an array).

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

Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" + "smithy.api#documentation": "

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" } }, "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues": { @@ -468,13 +468,13 @@ "displayName": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "

The display name assigned by Amazon Q Business to a plugin action. You can't\n modify this value.

" + "smithy.api#documentation": "

The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.

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

An Amazon Q Business suggested prompt and end user can use to invoke a plugin\n action. This value can be modified and sent as input to initiate an action. For\n example:

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

An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:

" } }, "description": { @@ -533,7 +533,7 @@ "status": { "target": "com.amazonaws.qbusiness#ApplicationStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon Q Business application. The application is ready to use when the\n status is ACTIVE.

" + "smithy.api#documentation": "

The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

" } }, "identityType": { @@ -678,12 +678,12 @@ "attachmentsControlMode": { "target": "com.amazonaws.qbusiness#AttachmentsControlMode", "traits": { - "smithy.api#documentation": "

Information about whether file upload during chat functionality is activated for your\n application.

" + "smithy.api#documentation": "

Information about whether file upload during chat functionality is activated for your application.

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

Configuration information about the file upload during chat feature for your\n application.

" + "smithy.api#documentation": "

Configuration information about the file upload during chat feature for your application.

" } }, "com.amazonaws.qbusiness#AppliedCreatorModeConfiguration": { @@ -692,13 +692,13 @@ "creatorModeControl": { "target": "com.amazonaws.qbusiness#CreatorModeControl", "traits": { - "smithy.api#documentation": "

Information about whether creator mode is enabled or disabled for an Amazon Q Business\n application.

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

Information about whether creator mode is enabled or disabled for an Amazon Q Business application.

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

The creator mode specific admin controls configured for an Amazon Q Business application.\n Determines whether an end user can generate LLM-only responses when they use the web\n experience.

\n

For more information, see Admin controls and guardrails and Conversation settings.

" + "smithy.api#documentation": "

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.

For more information, see Admin controls and guardrails and Conversation settings.

" } }, "com.amazonaws.qbusiness#AppliedOrchestrationConfiguration": { @@ -707,13 +707,13 @@ "control": { "target": "com.amazonaws.qbusiness#OrchestrationControl", "traits": { - "smithy.api#documentation": "

Information about whether chat orchestration is enabled or disabled for an\n Amazon Q Business application.

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

Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application.

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

The chat orchestration specific admin controls configured for an Amazon Q Business\n application. Determines whether Amazon Q Business automatically routes chat requests across\n configured plugins and data sources in your Amazon Q Business application.

\n

For more information, see Chat orchestration settings.

" + "smithy.api#documentation": "

The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application.

For more information, see Chat orchestration settings.

" } }, "com.amazonaws.qbusiness#AssociatePermission": { @@ -748,7 +748,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. \n This operation creates a new policy statement for the specified Amazon Q Business application. \n The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

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

Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

", "smithy.api#http": { "uri": "/applications/{applicationId}/policy", "method": "POST" @@ -806,6 +806,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#AssociatedGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group associated with the user. This is used to identify the group in access control decisions.

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

The type of the associated group. This indicates the scope of the group's applicability.

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

Represents a group associated with a given user in the access control system.

" + } + }, + "com.amazonaws.qbusiness#AssociatedGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AssociatedGroup" + } + }, + "com.amazonaws.qbusiness#AssociatedUser": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the associated user. This is used to identify the user in access control decisions.

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

The type of the associated user. This indicates the scope of the user's association.

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

Represents an associated user in the access control system.

" + } + }, + "com.amazonaws.qbusiness#AssociatedUsers": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#AssociatedUser" + } + }, "com.amazonaws.qbusiness#Attachment": { "type": "structure", "members": { @@ -914,7 +966,7 @@ } }, "traits": { - "smithy.api#documentation": "

A file input event activated by a end user request to upload files into their web\n experience chat.

" + "smithy.api#documentation": "

A file input event activated by a end user request to upload files into their web experience chat.

" } }, "com.amazonaws.qbusiness#AttachmentList": { @@ -994,7 +1046,7 @@ "attachmentsControlMode": { "target": "com.amazonaws.qbusiness#AttachmentsControlMode", "traits": { - "smithy.api#documentation": "

Status information about whether file upload functionality is activated or deactivated\n for your end user.

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

Status information about whether file upload functionality is activated or deactivated for your end user.

", "smithy.api#required": {} } } @@ -1061,43 +1113,43 @@ "equalsTo": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields. Supported\n for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.

" + "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

" } }, "containsAll": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "containsAny": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "greaterThan": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "greaterThanOrEquals": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater or equals than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "lessThan": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "lessThanOrEquals": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata\n fields.Supported for the following document attribute value type: dateValue\n and longValue.

" + "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

" } } }, @@ -1244,13 +1296,13 @@ "authorizationUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The URL sent by Amazon Q Business to the third party authentication server to authenticate\n a custom plugin user through an OAuth protocol.

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

The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.

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

A request made by Amazon Q Business to a third paty authentication server to authenticate\n a custom plugin user.

" + "smithy.api#documentation": "

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

" } }, "com.amazonaws.qbusiness#AuthChallengeRequestEvent": { @@ -1259,13 +1311,13 @@ "authorizationUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The URL sent by Amazon Q Business to a third party authentication server in response to an\n authentication verification event activated by an end user request to use a custom\n plugin.

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

The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.

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

An authentication verification event activated by an end user request to use a custom\n plugin.

" + "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom plugin.

" } }, "com.amazonaws.qbusiness#AuthChallengeResponse": { @@ -1280,7 +1332,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details of the authentication information received from a third party\n authentication server in response to an authentication challenge.

" + "smithy.api#documentation": "

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

" } }, "com.amazonaws.qbusiness#AuthChallengeResponseEvent": { @@ -1295,7 +1347,7 @@ } }, "traits": { - "smithy.api#documentation": "

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

" + "smithy.api#documentation": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

" } }, "com.amazonaws.qbusiness#AuthResponseKey": { @@ -1331,19 +1383,19 @@ "autoSubscribe": { "target": "com.amazonaws.qbusiness#AutoSubscriptionStatus", "traits": { - "smithy.api#documentation": "

Describes whether automatic subscriptions are enabled for an Amazon Q Business\n application using IAM identity federation for user management.

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

Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

", "smithy.api#required": {} } }, "defaultSubscriptionType": { "target": "com.amazonaws.qbusiness#SubscriptionType", "traits": { - "smithy.api#documentation": "

Describes the default subscription type assigned to an Amazon Q Business\n application using IAM identity federation for user management. If the\n value for autoSubscribe is set to ENABLED you must select a\n value for this field.

" + "smithy.api#documentation": "

Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.

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

Subscription configuration information for an Amazon Q Business application\n using IAM identity federation for user management.

" + "smithy.api#documentation": "

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

" } }, "com.amazonaws.qbusiness#AutoSubscriptionStatus": { @@ -1369,20 +1421,20 @@ "secretArn": { "target": "com.amazonaws.qbusiness#SecretArn", "traits": { - "smithy.api#documentation": "

The ARN of the Secrets Manager secret that stores the basic authentication\n credentials used for plugin configuration..

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

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.

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

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

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

Information about the basic authentication credentials used to configure a\n plugin.

" + "smithy.api#documentation": "

Information about the basic authentication credentials used to configure a plugin.

" } }, "com.amazonaws.qbusiness#BatchDeleteDocument": { @@ -1414,7 +1466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q Business index.

\n

You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.

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

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents/delete" @@ -1435,7 +1487,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business index that contains the documents to\n delete.

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

The identifier of the Amazon Q Business index that contains the documents to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1464,7 +1516,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "

A list of documents that couldn't be removed from the Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.

" + "smithy.api#documentation": "

A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

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

Adds one or more documents to an Amazon Q Business index.

\n

You use this API to:

\n \n

You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.

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

Adds one or more documents to an Amazon Q Business index.

You use this API to:

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents" @@ -1540,7 +1592,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3\n bucket.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

" } }, "dataSourceSyncId": { @@ -1560,7 +1612,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "

A list of documents that were not added to the Amazon Q Business index because the\n document failed a validation check. Each document contains an error message that\n indicates why the document couldn't be added to the index.

" + "smithy.api#documentation": "

A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

" } } }, @@ -1598,12 +1650,12 @@ "systemMessageOverride": { "target": "com.amazonaws.qbusiness#SystemMessageOverride", "traits": { - "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've\n used a blocked phrase during chat.

" + "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

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

Provides information about the phrases blocked from chat by your chat control\n configuration.

" + "smithy.api#documentation": "

Provides information about the phrases blocked from chat by your chat control configuration.

" } }, "com.amazonaws.qbusiness#BlockedPhrasesConfigurationUpdate": { @@ -1612,7 +1664,7 @@ "blockedPhrasesToCreateOrUpdate": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "

Creates or updates a blocked phrases configuration in your Amazon Q Business\n application.

" + "smithy.api#documentation": "

Creates or updates a blocked phrases configuration in your Amazon Q Business application.

" } }, "blockedPhrasesToDelete": { @@ -1624,7 +1676,7 @@ "systemMessageOverride": { "target": "com.amazonaws.qbusiness#SystemMessageOverride", "traits": { - "smithy.api#documentation": "

The configured custom message displayed to your end user when they use blocked phrase\n during chat.

" + "smithy.api#documentation": "

The configured custom message displayed to your end user when they use blocked phrase during chat.

" } } }, @@ -1662,7 +1714,7 @@ "enabledBrowserExtensions": { "target": "com.amazonaws.qbusiness#BrowserExtensionList", "traits": { - "smithy.api#documentation": "

Specify the browser extensions allowed for your Amazon Q web experience.

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

Specify the browser extensions allowed for your Amazon Q web experience.

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

Unsubscribes a user or a group from their pricing tier in an Amazon Q Business\n application. An unsubscribed user or group loses all Amazon Q Business feature access at the\n start of next month.

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

Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/subscriptions/{subscriptionId}" @@ -1724,7 +1776,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application for which the subscription is being\n cancelled.

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

The identifier of the Amazon Q Business application for which the subscription is being cancelled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1748,7 +1800,7 @@ "subscriptionArn": { "target": "com.amazonaws.qbusiness#SubscriptionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription being\n cancelled.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.

" } }, "currentSubscription": { @@ -1816,7 +1868,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business\n conversation.

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

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1875,13 +1927,13 @@ "configurationEvent": { "target": "com.amazonaws.qbusiness#ConfigurationEvent", "traits": { - "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat\n mode.

" + "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat mode.

" } }, "textEvent": { "target": "com.amazonaws.qbusiness#TextInputEvent", "traits": { - "smithy.api#documentation": "

Information about the payload of the ChatInputStream event containing the\n end user message input.

" + "smithy.api#documentation": "

Information about the payload of the ChatInputStream event containing the end user message input.

" } }, "attachmentEvent": { @@ -1905,7 +1957,7 @@ "authChallengeResponseEvent": { "target": "com.amazonaws.qbusiness#AuthChallengeResponseEvent", "traits": { - "smithy.api#documentation": "

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

" + "smithy.api#documentation": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

" } } }, @@ -1948,7 +2000,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for Amazon Q Business conversation modes.

\n

For more information, see Admin controls and guardrails and Conversation settings.

" + "smithy.api#documentation": "

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

" } }, "com.amazonaws.qbusiness#ChatOutput": { @@ -1972,19 +2024,19 @@ "textEvent": { "target": "com.amazonaws.qbusiness#TextOutputEvent", "traits": { - "smithy.api#documentation": "

Information about the payload of the ChatOutputStream event containing\n the AI-generated message output.

" + "smithy.api#documentation": "

Information about the payload of the ChatOutputStream event containing the AI-generated message output.

" } }, "metadataEvent": { "target": "com.amazonaws.qbusiness#MetadataEvent", "traits": { - "smithy.api#documentation": "

A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation.

" + "smithy.api#documentation": "

A metadata event for a AI-generated text output message in a Amazon Q Business conversation.

" } }, "actionReviewEvent": { "target": "com.amazonaws.qbusiness#ActionReviewEvent", "traits": { - "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.

" + "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

" } }, "failedAttachmentEvent": { @@ -1996,7 +2048,7 @@ "authChallengeRequestEvent": { "target": "com.amazonaws.qbusiness#AuthChallengeRequestEvent", "traits": { - "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom\n plugin.

" + "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom plugin.

" } } }, @@ -2053,7 +2105,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to the Amazon Q Business\n conversation.

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

The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2081,7 +2133,7 @@ "attachments": { "target": "com.amazonaws.qbusiness#AttachmentsInput", "traits": { - "smithy.api#documentation": "

A list of files uploaded directly during chat. You can upload a maximum of 5 files of\n upto 10 MB each.

" + "smithy.api#documentation": "

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

" } }, "actionExecution": { @@ -2093,7 +2145,7 @@ "authChallengeResponse": { "target": "com.amazonaws.qbusiness#AuthChallengeResponse", "traits": { - "smithy.api#documentation": "

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

" + "smithy.api#documentation": "

An authentication verification event response by a third party authentication server to Amazon Q Business.

" } }, "conversationId": { @@ -2111,13 +2163,13 @@ "attributeFilter": { "target": "com.amazonaws.qbusiness#AttributeFilter", "traits": { - "smithy.api#documentation": "

Enables filtering of Amazon Q Business web experience responses based on document\n attributes or metadata fields.

" + "smithy.api#documentation": "

Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

" } }, "chatMode": { "target": "com.amazonaws.qbusiness#ChatMode", "traits": { - "smithy.api#documentation": "

The chatMode parameter determines the chat modes available to \n Amazon Q Business users:

\n \n \n

If none of the modes are selected, Amazon Q will only respond using the information\n from the attached files.

\n \n

For more information, see Admin controls and guardrails, Plugins,\n and Response sources.

" + "smithy.api#documentation": "

The chatMode parameter determines the chat modes available to Amazon Q Business users:

If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

For more information, see Admin controls and guardrails, Plugins, and Response sources.

" } }, "chatModeConfiguration": { @@ -2156,25 +2208,25 @@ "systemMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated message within the\n conversation.

" + "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated message within the conversation.

" } }, "userMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "

The identifier of an Amazon Q Business end user text input message within the\n conversation.

" + "smithy.api#documentation": "

The identifier of an Amazon Q Business end user text input message within the conversation.

" } }, "actionReview": { "target": "com.amazonaws.qbusiness#ActionReview", "traits": { - "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.

" + "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

" } }, "authChallengeRequest": { "target": "com.amazonaws.qbusiness#AuthChallengeRequest", "traits": { - "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom\n plugin.

" + "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom plugin.

" } }, "sourceAttributions": { @@ -2194,6 +2246,119 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#CheckDocumentAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CheckDocumentAccessRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CheckDocumentAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#CheckDocumentAccessRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentId": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the document. Specifies which document's access permissions are being checked.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

", + "smithy.api#httpQuery": "dataSourceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CheckDocumentAccessResponse": { + "type": "structure", + "members": { + "userGroups": { + "target": "com.amazonaws.qbusiness#AssociatedGroups", + "traits": { + "smithy.api#documentation": "

An array of groups the user is part of for the specified data source. Each group has a name and type.

" + } + }, + "userAliases": { + "target": "com.amazonaws.qbusiness#AssociatedUsers", + "traits": { + "smithy.api#documentation": "

An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

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

A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.

" + } + }, + "documentAcl": { + "target": "com.amazonaws.qbusiness#DocumentAcl", + "traits": { + "smithy.api#documentation": "

The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#ClientIdForOIDC": { "type": "string", "traits": { @@ -2235,7 +2400,7 @@ "chatMode": { "target": "com.amazonaws.qbusiness#ChatMode", "traits": { - "smithy.api#documentation": "

The chat modes available to an Amazon Q Business end user.

\n \n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" + "smithy.api#documentation": "

The chat modes available to an Amazon Q Business end user.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

" } }, "chatModeConfiguration": { @@ -2246,7 +2411,7 @@ } }, "traits": { - "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat\n mode.

" + "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat mode.

" } }, "com.amazonaws.qbusiness#ConflictException": { @@ -2275,7 +2440,7 @@ } }, "traits": { - "smithy.api#documentation": "

You are trying to perform an action that conflicts with the current status of your\n resource. Fix any inconsistencies with your resources and try again.

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

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2286,12 +2451,12 @@ "systemMessageOverride": { "target": "com.amazonaws.qbusiness#SystemMessageOverride", "traits": { - "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've\n used a blocked phrase during chat.

" + "smithy.api#documentation": "

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

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

A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.

" + "smithy.api#documentation": "

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

" } }, "com.amazonaws.qbusiness#ContentRetrievalRule": { @@ -2300,12 +2465,12 @@ "eligibleDataSources": { "target": "com.amazonaws.qbusiness#EligibleDataSources", "traits": { - "smithy.api#documentation": "

Specifies data sources in a Amazon Q Business application to use for content\n generation.

" + "smithy.api#documentation": "

Specifies data sources in a Amazon Q Business application to use for content generation.

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

Rules for retrieving content from data sources connected to a Amazon Q Business\n application for a specific topic control configuration.

" + "smithy.api#documentation": "

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

" } }, "com.amazonaws.qbusiness#ContentSource": { @@ -2534,7 +2699,7 @@ "quicksight:DescribeAccountSubscription", "quicksight:ListNamespaces" ], - "smithy.api#documentation": "

Creates an Amazon Q Business application.

\n \n

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are\n also available in Amazon Q Business Lite. For information on what's included in\n Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign\n subscription tiers to users.

\n

An Amazon Q Apps service linked role will be created if it's absent in the\n Amazon Web Services account when QAppsConfiguration is enabled in\n the request. For more information, see Using\n service-linked roles for Q Apps.

\n

When you create an application, Amazon Q Business may securely transmit data for\n processing from your selected Amazon Web Services region, but within your geography.\n For more information, see Cross region\n inference in Amazon Q Business.

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

Creates an Amazon Q Business application.

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

", "smithy.api#http": { "uri": "/applications", "method": "POST" @@ -2555,7 +2720,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the\n application's role.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.

" } }, "identityType": { @@ -2573,7 +2738,7 @@ "identityCenterInstanceArn": { "target": "com.amazonaws.qbusiness#InstanceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for\u2014or connecting to\u2014your Amazon Q Business application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for\u2014or connecting to\u2014your Amazon Q Business application.

" } }, "clientIdsForOIDC": { @@ -2591,20 +2756,20 @@ "encryptionConfiguration": { "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt your data.\n Amazon Q Business doesn't support asymmetric keys.

" + "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

" } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q Business application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q Business\n application.

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

A token that you provide to identify the request to create your Amazon Q Business application.

", "smithy.api#idempotencyToken": {} } }, @@ -2618,19 +2783,19 @@ "qAppsConfiguration": { "target": "com.amazonaws.qbusiness#QAppsConfiguration", "traits": { - "smithy.api#documentation": "

An option to allow end users to create and use Amazon Q Apps in the web\n experience.

" + "smithy.api#documentation": "

An option to allow end users to create and use Amazon Q Apps in the web experience.

" } }, "personalizationConfiguration": { "target": "com.amazonaws.qbusiness#PersonalizationConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information about chat response personalization. For more information,\n see Personalizing chat responses\n

" + "smithy.api#documentation": "

Configuration information about chat response personalization. For more information, see Personalizing chat responses

" } }, "quickSightConfiguration": { "target": "com.amazonaws.qbusiness#QuickSightConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is\n required if your application uses QuickSight as the identity provider. For more information, see Creating an\n Amazon QuickSight integrated application.

" + "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

" } } }, @@ -2699,7 +2864,7 @@ "qbusiness:TagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Creates a new data accessor for an ISV to access data from a Amazon Q Business application. \n The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. \n It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the \n specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, \n an IAM Identity Center application is also created to manage the ISV's identity and authentication for \n accessing the Amazon Q Business application.

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

Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

", "smithy.api#http": { "uri": "/applications/{applicationId}/dataaccessors", "method": "POST" @@ -2829,7 +2994,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "

Creates a data source connector for an Amazon Q Business application.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.

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

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources", "method": "POST" @@ -2843,7 +3008,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the data source will be attached\n to.

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

The identifier of the Amazon Q Business application the data source will be attached to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2851,7 +3016,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "

The identifier of the index that you want to use with the data source\n connector.

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

The identifier of the index that you want to use with the data source connector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2867,14 +3032,14 @@ "configuration": { "target": "com.amazonaws.qbusiness#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration\n information specific to your data source connector.

\n

Each data source has a JSON schema provided by Amazon Q Business that you must\n use. For example, the Amazon S3 and Web Crawler connectors require the following\n JSON schemas:

\n \n

You can find configuration templates for your specific data source using the following\n steps:

\n
    \n
  1. \n

    Navigate to the Supported\n connectors page in the Amazon Q Business User Guide, and\n select the data source of your choice.

    \n
    2. \n
  2. \n

    Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your\n data source, including parameter descriptions, in this section.

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

Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

You can find configuration templates for your specific data source using the following steps:

  1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.

  2. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.

", "smithy.api#required": {} } }, "vpcConfiguration": { "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q Business connectors.

" + "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

" } }, "description": { @@ -2887,25 +3052,25 @@ "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "syncSchedule": { "target": "com.amazonaws.qbusiness#SyncSchedule", "traits": { - "smithy.api#documentation": "

Sets the frequency for Amazon Q Business to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q Business won't\n periodically update the index.

\n

Specify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.

" + "smithy.api#documentation": "

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token you provide to identify a request to create a data source connector. Multiple\n calls to the CreateDataSource API with the same client token will create\n only one data source connector.

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

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

", "smithy.api#idempotencyToken": {} } }, @@ -2935,7 +3100,7 @@ "dataSourceArn": { "target": "com.amazonaws.qbusiness#DataSourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

" } } }, @@ -2984,7 +3149,7 @@ "qbusiness:TagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Creates an Amazon Q Business index.

\n

To determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

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

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices", "method": "POST" @@ -3019,26 +3184,26 @@ "type": { "target": "com.amazonaws.qbusiness#IndexType", "traits": { - "smithy.api#documentation": "

The index type that's suitable for your needs. For more information on what's included\n in each type of index, see Amazon Q Business\n tiers.

" + "smithy.api#documentation": "

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

" } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the index. You can also use tags\n to help control access to the index. Tag keys and values can consist of Unicode letters,\n digits, white space, and any of the following symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "

The capacity units you want to provision for your index. You can add and remove\n capacity to fit your usage needs.

" + "smithy.api#documentation": "

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create an index. Multiple calls to\n the CreateIndex API with the same client token will create only one\n index.

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

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

", "smithy.api#idempotencyToken": {} } } @@ -3164,13 +3329,13 @@ "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You\n can also use tags to help control access to the data source connector. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q Business\n plugin.

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

A token that you provide to identify the request to create your Amazon Q Business plugin.

", "smithy.api#idempotencyToken": {} } } @@ -3289,13 +3454,13 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.

" + "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q Business\n application retriever.

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

A token that you provide to identify the request to create your Amazon Q Business application retriever.

", "smithy.api#idempotencyToken": {} } }, @@ -3303,7 +3468,7 @@ "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the retriever. You can also use\n tags to help control access to the retriever. Tag keys and values can consist of Unicode\n letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

Subscribes an IAM Identity Center user or a group to a pricing tier for an\n Amazon Q Business application.

\n

Amazon Q Business offers two subscription tiers: Q_LITE and\n Q_BUSINESS. Subscription tier determines feature access for the user.\n For more information on subscriptions and pricing tiers, see Amazon Q Business\n pricing.

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

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/subscriptions" @@ -3374,7 +3539,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the subscription should be added\n to.

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

The identifier of the Amazon Q Business application the subscription should be added to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3382,7 +3547,7 @@ "principal": { "target": "com.amazonaws.qbusiness#SubscriptionPrincipal", "traits": { - "smithy.api#documentation": "

The IAM Identity Center UserId or GroupId of a user or group\n in the IAM Identity Center instance connected to the Amazon Q Business application.

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

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

", "smithy.api#required": {} } }, @@ -3396,7 +3561,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create a subscription for your\n Amazon Q Business application.

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

A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

", "smithy.api#idempotencyToken": {} } } @@ -3469,7 +3634,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a universally unique identifier (UUID) mapped to a list of local user ids\n within an application.

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

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/users" @@ -3508,7 +3673,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create your Amazon Q Business user\n mapping.

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

A token that you provide to identify the request to create your Amazon Q Business user mapping.

", "smithy.api#idempotencyToken": {} } } @@ -3601,51 +3766,51 @@ "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q Business web\n experience.

" + "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q Business web experience.

" } }, "samplePromptsControlMode": { "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", "traits": { - "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end user.

" } }, "origins": { "target": "com.amazonaws.qbusiness#WebExperienceOrigins", "traits": { - "smithy.api#documentation": "

Sets the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).\n

\n \n

You must only submit a base URL and \n not a full path. For example, https://docs.aws.amazon.com.

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

Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role attached to your web\n experience.

\n \n

You must provide this value if you're using IAM Identity Center to manage end user\n access to your application. If you're using legacy identity management to manage\n user access, you don't need to provide this value.

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

The Amazon Resource Name (ARN) of the service role attached to your web experience.

You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

" } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q Business web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token you provide to identify a request to create an Amazon Q Business web experience.\n

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

A token you provide to identify a request to create an Amazon Q Business web experience.

", "smithy.api#idempotencyToken": {} } }, "identityProviderConfiguration": { "target": "com.amazonaws.qbusiness#IdentityProviderConfiguration", "traits": { - "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an\n Amazon Q Business web experience.

" + "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "browserExtensionConfiguration": { "target": "com.amazonaws.qbusiness#BrowserExtensionConfiguration", "traits": { - "smithy.api#documentation": "

The browser extension configuration for an Amazon Q Business web experience.

\n \n

\n For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).\n The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.\n For more information, see Configure external OIDC identity provider for your browser extensions..\n

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

The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

" } }, "customizationConfiguration": { @@ -3685,13 +3850,13 @@ "creatorModeControl": { "target": "com.amazonaws.qbusiness#CreatorModeControl", "traits": { - "smithy.api#documentation": "

Status information about whether CREATOR_MODE has been enabled or\n disabled. The default status is DISABLED.

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

Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

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

Configuration information required to invoke chat in CREATOR_MODE.

\n

For more information, see Admin controls and guardrails and Conversation settings.

" + "smithy.api#documentation": "

Configuration information required to invoke chat in CREATOR_MODE.

For more information, see Admin controls and guardrails and Conversation settings.

" } }, "com.amazonaws.qbusiness#CreatorModeControl": { @@ -3741,7 +3906,7 @@ "apiSchema": { "target": "com.amazonaws.qbusiness#APISchema", "traits": { - "smithy.api#documentation": "

Contains either details about the S3 object containing the OpenAPI schema for the\n action group or the JSON or YAML-formatted payload defining the schema.

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

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

", "smithy.api#required": {} } } @@ -4091,30 +4256,30 @@ "status": { "target": "com.amazonaws.qbusiness#DataSourceSyncJobStatus", "traits": { - "smithy.api#documentation": "

The status of the synchronization job. When the Status field is set to\n SUCCEEDED, the synchronization job is done. If the status code is\n FAILED, the ErrorCode and ErrorMessage fields\n give you the reason for the failure.

" + "smithy.api#documentation": "

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

" } }, "error": { "target": "com.amazonaws.qbusiness#ErrorDetail", "traits": { - "smithy.api#documentation": "

If the Status field is set to FAILED, the\n ErrorCode field indicates the reason the synchronization failed.

" + "smithy.api#documentation": "

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

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

If the reason that the synchronization failed is due to an error with the underlying\n data source, this field contains a code that identifies the error.

" + "smithy.api#documentation": "

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

" } }, "metrics": { "target": "com.amazonaws.qbusiness#DataSourceSyncJobMetrics", "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 data source\n connector.

" + "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

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

Provides information about an Amazon Q Business data source connector synchronization\n job.

" + "smithy.api#documentation": "

Provides information about an Amazon Q Business data source connector synchronization job.

" } }, "com.amazonaws.qbusiness#DataSourceSyncJobMetrics": { @@ -4123,36 +4288,36 @@ "documentsAdded": { "target": "com.amazonaws.qbusiness#MetricValue", "traits": { - "smithy.api#documentation": "

The current count of documents added from the data source during the data source\n sync.

" + "smithy.api#documentation": "

The current count of documents added from the data source during the data source sync.

" } }, "documentsModified": { "target": "com.amazonaws.qbusiness#MetricValue", "traits": { - "smithy.api#documentation": "

The current count of documents modified in the data source during the data source\n sync.

" + "smithy.api#documentation": "

The current count of documents modified in the data source during the data source sync.

" } }, "documentsDeleted": { "target": "com.amazonaws.qbusiness#MetricValue", "traits": { - "smithy.api#documentation": "

The current count of documents deleted from the data source during the data source\n sync.

" + "smithy.api#documentation": "

The current count of documents deleted from the data source during the data source sync.

" } }, "documentsFailed": { "target": "com.amazonaws.qbusiness#MetricValue", "traits": { - "smithy.api#documentation": "

The current count of documents that failed to sync from the data source during the\n data source sync.

" + "smithy.api#documentation": "

The current count of documents that failed to sync from the data source during the data source sync.

" } }, "documentsScanned": { "target": "com.amazonaws.qbusiness#MetricValue", "traits": { - "smithy.api#documentation": "

The current count of documents crawled by the ongoing sync job in the data\n source.

" + "smithy.api#documentation": "

The current count of documents crawled by the ongoing sync job in the data source.

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

Maps a batch delete document request to a specific Amazon Q Business data source connector\n sync job.

" + "smithy.api#documentation": "

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

" } }, "com.amazonaws.qbusiness#DataSourceSyncJobStatus": { @@ -4224,20 +4389,20 @@ "subnetIds": { "target": "com.amazonaws.qbusiness#SubnetIds", "traits": { - "smithy.api#documentation": "

A list of identifiers for subnets within your Amazon VPC. The subnets should\n be able 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 for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.qbusiness#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q Business to connect to the data source.

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

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

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

Provides configuration information needed to connect to an Amazon VPC (Virtual\n Private Cloud).

" + "smithy.api#documentation": "

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

" } }, "com.amazonaws.qbusiness#DataSources": { @@ -4259,12 +4424,12 @@ "boostingDurationInSeconds": { "target": "com.amazonaws.qbusiness#BoostingDurationInSeconds", "traits": { - "smithy.api#documentation": "

Specifies the duration, in seconds, of a boost applies to a DATE type\n document attribute.

" + "smithy.api#documentation": "

Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

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

Provides information on boosting DATE type document attributes.

\n

For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.

" + "smithy.api#documentation": "

Provides information on boosting DATE type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

" } }, "com.amazonaws.qbusiness#DeleteApplication": { @@ -4524,7 +4689,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application associated with the\n conversation.

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

The identifier of the Amazon Q Business application associated with the conversation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4580,7 +4745,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetDataAccessor" ], - "smithy.api#documentation": "

Deletes a specified data accessor. This operation permanently removes the data accessor \n and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

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

Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

", "smithy.api#http": { "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", "method": "DELETE" @@ -4651,7 +4816,7 @@ "aws.iam#requiredActions": [ "qbusiness:GetDataSource" ], - "smithy.api#documentation": "

Deletes an Amazon Q Business data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.

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

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "method": "DELETE" @@ -4665,7 +4830,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application used with the data source\n connector.

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

The identifier of the Amazon Q Business application used with the data source connector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4748,7 +4913,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a group so that all users and sub groups that belong to the group can no\n longer access documents only available to that group. For example, after deleting the\n group \"Summer Interns\", all interns who belonged to that group no longer see intern-only\n documents in their chat results.

\n

If you want to delete, update, or replace users or sub groups of a group, you need to\n use the PutGroup operation. For example, if a user in the group\n \"Engineering\" leaves the engineering team and another user takes their place, you\n provide an updated list of users or sub groups that belong to the \"Engineering\" group\n when calling PutGroup.

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

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutGroup.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}" @@ -4786,7 +4951,7 @@ "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "

The identifier of the data source linked to the group

\n

A group can be tied to multiple data sources. You can delete a group from accessing\n documents in a certain data source. For example, the groups \"Research\", \"Engineering\",\n and \"Sales and Marketing\" are all tied to the company's documents stored in the data\n sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\"\n groups from Salesforce, so that these groups cannot access customer-related documents\n stored in Salesforce. Only \"Sales and Marketing\" should access documents in the\n Salesforce data source.

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

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data source.

", "smithy.api#httpQuery": "dataSourceId" } } @@ -4848,7 +5013,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the Amazon Q Business index is linked\n to.

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

The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5129,7 +5294,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to the Amazon Q Business web\n experience.

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

The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5193,7 +5358,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was \n previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

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

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

", "smithy.api#http": { "uri": "/applications/{applicationId}/policy/{statementId}", "method": "DELETE" @@ -5245,7 +5410,7 @@ "attributes": { "target": "com.amazonaws.qbusiness#DocumentAttributes", "traits": { - "smithy.api#documentation": "

Custom attributes to apply to the document for refining Amazon Q Business web experience\n responses.

" + "smithy.api#documentation": "

Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

" } }, "content": { @@ -5257,7 +5422,7 @@ "contentType": { "target": "com.amazonaws.qbusiness#ContentType", "traits": { - "smithy.api#documentation": "

The file type of the document in the Blob field.

\n

If you want to index snippets or subsets of HTML documents instead of the entirety of\n the HTML documents, you add the HTML start and closing tags\n (<HTML>content</HTML>) around the content.

" + "smithy.api#documentation": "

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

" } }, "title": { @@ -5275,7 +5440,7 @@ "documentEnrichmentConfiguration": { "target": "com.amazonaws.qbusiness#DocumentEnrichmentConfiguration", "traits": { - "smithy.api#documentation": "

The configuration information for altering document metadata and content during the\n document ingestion process.

" + "smithy.api#documentation": "

The configuration information for altering document metadata and content during the document ingestion process.

" } }, "mediaExtractionConfiguration": { @@ -5289,6 +5454,130 @@ "smithy.api#documentation": "

A document in an Amazon Q Business application.

" } }, + "com.amazonaws.qbusiness#DocumentAcl": { + "type": "structure", + "members": { + "allowlist": { + "target": "com.amazonaws.qbusiness#DocumentAclMembership", + "traits": { + "smithy.api#documentation": "

The allowlist conditions for the document. Users or groups matching these conditions are granted access to the document.

" + } + }, + "denyList": { + "target": "com.amazonaws.qbusiness#DocumentAclMembership", + "traits": { + "smithy.api#documentation": "

The denylist conditions for the document. Users or groups matching these conditions are denied access to the document, overriding allowlist permissions.

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

Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.

" + } + }, + "com.amazonaws.qbusiness#DocumentAclCondition": { + "type": "structure", + "members": { + "memberRelation": { + "target": "com.amazonaws.qbusiness#MemberRelation", + "traits": { + "smithy.api#documentation": "

The logical relation between members in the condition, determining how multiple user or group conditions are combined.

" + } + }, + "users": { + "target": "com.amazonaws.qbusiness#DocumentAclUsers", + "traits": { + "smithy.api#documentation": "

An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition.

" + } + }, + "groups": { + "target": "com.amazonaws.qbusiness#DocumentAclGroups", + "traits": { + "smithy.api#documentation": "

An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition.

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

Represents a condition in the document's ACL, specifying access rules for users and groups.

" + } + }, + "com.amazonaws.qbusiness#DocumentAclConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentAclCondition" + } + }, + "com.amazonaws.qbusiness#DocumentAclGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.qbusiness#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group in the document's ACL. This is used to identify the group when applying access rules.

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

The type of the group. This indicates the scope of the group's applicability in access control.

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

Represents a group in the document's ACL, used to define access permissions for multiple users collectively.

" + } + }, + "com.amazonaws.qbusiness#DocumentAclGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentAclGroup" + } + }, + "com.amazonaws.qbusiness#DocumentAclMembership": { + "type": "structure", + "members": { + "memberRelation": { + "target": "com.amazonaws.qbusiness#MemberRelation", + "traits": { + "smithy.api#documentation": "

The logical relation between members in the membership rule, determining how multiple conditions are combined.

" + } + }, + "conditions": { + "target": "com.amazonaws.qbusiness#DocumentAclConditions", + "traits": { + "smithy.api#documentation": "

An array of conditions that define the membership rules. Each condition specifies criteria for users or groups to be included in this membership.

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

Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.

" + } + }, + "com.amazonaws.qbusiness#DocumentAclUser": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the user in the document's ACL. This is used to identify the user when applying access rules.

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

The type of the user. This indicates the scope of the user's applicability in access control.

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

Represents a user in the document's ACL, used to define access permissions for individual users.

" + } + }, + "com.amazonaws.qbusiness#DocumentAclUsers": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#DocumentAclUser" + } + }, "com.amazonaws.qbusiness#DocumentAttribute": { "type": "structure", "members": { @@ -5335,12 +5624,12 @@ "stringListConfiguration": { "target": "com.amazonaws.qbusiness#StringListAttributeBoostingConfiguration", "traits": { - "smithy.api#documentation": "

Provides information on boosting STRING_LIST type document\n attributes.

" + "smithy.api#documentation": "

Provides information on boosting STRING_LIST type document attributes.

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

Provides information on boosting supported Amazon Q Business document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q Business prioritizes generating responses from content that matches the boosted\n document attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.

" + "smithy.api#documentation": "

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

" } }, "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel": { @@ -5398,14 +5687,14 @@ "key": { "target": "com.amazonaws.qbusiness#DocumentAttributeKey", "traits": { - "smithy.api#documentation": "

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Q Business currently doesn't support _document_body as an attribute\n key used for the condition.

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

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator", "traits": { - "smithy.api#documentation": "

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Q Business currently does not support _document_body as an attribute\n key used for the condition.

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

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

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

The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q Business. You use this with \n DocumentAttributeTarget\n to apply the condition.

\n

For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.

\n

Amazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q Business then will map your newly\n created metadata field to your index field.

" + "smithy.api#documentation": "

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

" } }, "com.amazonaws.qbusiness#DocumentAttributeConfiguration": { @@ -5435,12 +5724,12 @@ "search": { "target": "com.amazonaws.qbusiness#Status", "traits": { - "smithy.api#documentation": "

Information about whether the document attribute can be used by an end user to search\n for information on their web experience.

" + "smithy.api#documentation": "

Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

Configuration information for document attributes. Document attributes are metadata or\n fields associated with your documents. For example, the company department name\n associated with each document.

\n

For more information, see Understanding document attributes.

" + "smithy.api#documentation": "

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

" } }, "com.amazonaws.qbusiness#DocumentAttributeConfigurations": { @@ -5485,7 +5774,7 @@ "key": { "target": "com.amazonaws.qbusiness#DocumentAttributeKey", "traits": { - "smithy.api#documentation": "

The identifier of the target document attribute or metadata field. For example,\n 'Department' could be an identifier for the target attribute or metadata field that\n includes the department names associated with the documents.

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

The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

", "smithy.api#required": {} } }, @@ -5495,12 +5784,12 @@ "attributeValueOperator": { "target": "com.amazonaws.qbusiness#AttributeValueOperator", "traits": { - "smithy.api#documentation": "

\n TRUE to delete the existing target value for your specified target\n attribute key. You cannot create a target value and set this to\n TRUE.

" + "smithy.api#documentation": "

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

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

The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q Business.

\n

For example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.

\n

Amazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q Business\n will then map your newly created document attribute to your index field.

\n

You can also use this with \n DocumentAttributeCondition\n .

" + "smithy.api#documentation": "

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

" } }, "com.amazonaws.qbusiness#DocumentAttributeValue": { @@ -5530,12 +5819,12 @@ "dateValue": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601 date-time format. For\n example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012\n at 12:30PM (plus 10 seconds) in Central European Time.

" + "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

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

The value of a document attribute. You can only provide one value for a document\n attribute.

" + "smithy.api#documentation": "

The value of a document attribute. You can only provide one value for a document attribute.

" } }, "com.amazonaws.qbusiness#DocumentAttributes": { @@ -5556,7 +5845,7 @@ "blob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the\n Amazon Q Business endpoint directly using REST, you must base64 encode the contents before\n sending.

" + "smithy.api#documentation": "

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

" } }, "s3": { @@ -5702,7 +5991,7 @@ "inlineConfigurations": { "target": "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations", "traits": { - "smithy.api#documentation": "

Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q Business.

" + "smithy.api#documentation": "

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

" } }, "preExtractionHookConfiguration": { @@ -5713,7 +6002,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information for altering document metadata and content\n during the document ingestion process.

\n

For more information, see Custom document\n enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#DocumentId": { @@ -5838,12 +6127,12 @@ "kmsKeyId": { "target": "com.amazonaws.qbusiness#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier of the KMS key. Amazon Q Business doesn't support asymmetric\n keys.

" + "smithy.api#documentation": "

The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

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

Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

" + "smithy.api#documentation": "

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

" } }, "com.amazonaws.qbusiness#EndOfInputEvent": { @@ -5964,6 +6253,9 @@ { "target": "com.amazonaws.qbusiness#ChatSync" }, + { + "target": "com.amazonaws.qbusiness#CheckDocumentAccess" + }, { "target": "com.amazonaws.qbusiness#CreateSubscription" }, @@ -6091,7 +6383,7 @@ "h2" ] }, - "smithy.api#documentation": "

This is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .

\n

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

\n

For information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.

\n

The following resources provide additional information about using the Amazon Q Business\n API:

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

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

The following resources provide additional information about using the Amazon Q Business API:

", "smithy.api#title": "QBusiness", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -6472,7 +6764,7 @@ } }, "traits": { - "smithy.api#documentation": "

An external resource that you configured with your application is returning errors and\n preventing this operation from succeeding. Fix those errors and try again.\n

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

An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -6512,7 +6804,7 @@ "id": { "target": "com.amazonaws.qbusiness#DocumentId", "traits": { - "smithy.api#documentation": "

The identifier of the document that couldn't be removed from the Amazon Q Business\n index.

" + "smithy.api#documentation": "

The identifier of the document that couldn't be removed from the Amazon Q Business index.

" } }, "error": { @@ -6524,12 +6816,12 @@ "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business data source connector that contains the failed\n document.

" + "smithy.api#documentation": "

The identifier of the Amazon Q Business data source connector that contains the failed document.

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

A list of documents that could not be removed from an Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.

" + "smithy.api#documentation": "

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

" } }, "com.amazonaws.qbusiness#FailedDocuments": { @@ -6647,13 +6939,13 @@ "identityCenterApplicationArn": { "target": "com.amazonaws.qbusiness#IdcApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to\n your Amazon Q Business application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM with permissions to access\n your CloudWatch logs and metrics.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

" } }, "status": { @@ -6672,7 +6964,7 @@ "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q Business doesn't support\n asymmetric keys.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

" } }, "createdAt": { @@ -6691,7 +6983,7 @@ "target": "com.amazonaws.qbusiness#ErrorDetail", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "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.

" + "smithy.api#documentation": "

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

" } }, "attachmentsConfiguration": { @@ -6704,19 +6996,19 @@ "qAppsConfiguration": { "target": "com.amazonaws.qbusiness#QAppsConfiguration", "traits": { - "smithy.api#documentation": "

Settings for whether end users can create and use Amazon Q Apps in the web\n experience.

" + "smithy.api#documentation": "

Settings for whether end users can create and use Amazon Q Apps in the web experience.

" } }, "personalizationConfiguration": { "target": "com.amazonaws.qbusiness#PersonalizationConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information about chat response personalization. For more information,\n see Personalizing chat responses.

" + "smithy.api#documentation": "

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

" } }, "autoSubscriptionConfiguration": { "target": "com.amazonaws.qbusiness#AutoSubscriptionConfiguration", "traits": { - "smithy.api#documentation": "

Settings for auto-subscription behavior for this application. This is only applicable\n to SAML and OIDC applications.

" + "smithy.api#documentation": "

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

" } }, "clientIdsForOIDC": { @@ -6762,7 +7054,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about chat controls configured for an existing Amazon Q Business\n application.

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

Gets information about chat controls configured for an existing Amazon Q Business application.

", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "GET", @@ -6798,7 +7090,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

", "smithy.api#httpQuery": "nextToken" } } @@ -6813,13 +7105,13 @@ "responseScope": { "target": "com.amazonaws.qbusiness#ResponseScope", "traits": { - "smithy.api#documentation": "

The response scope configured for a Amazon Q Business application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.

" + "smithy.api#documentation": "

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

" } }, "orchestrationConfiguration": { "target": "com.amazonaws.qbusiness#AppliedOrchestrationConfiguration", "traits": { - "smithy.api#documentation": "

The chat response orchestration settings for your application.

\n \n

Chat orchestration is optimized to work for English language content. For more\n details on language support in Amazon Q Business, see Supported languages.

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

The chat response orchestration settings for your application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

" } }, "blockedPhrases": { @@ -6843,7 +7135,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.

" + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

" + } + }, + "hallucinationReductionConfiguration": { + "target": "com.amazonaws.qbusiness#HallucinationReductionConfiguration", + "traits": { + "smithy.api#documentation": "

The hallucination reduction settings for your application.

" } } }, @@ -6880,7 +7178,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Retrieves information about a specified data accessor. This operation returns details about the \n data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated \n Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the \n action configurations, and the timestamps for when the data accessor was created and last updated.

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

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

", "smithy.api#http": { "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", "method": "GET" @@ -7091,7 +7389,7 @@ "vpcConfiguration": { "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source.

" + "smithy.api#documentation": "

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

" } }, "createdAt": { @@ -7115,7 +7413,7 @@ "status": { "target": "com.amazonaws.qbusiness#DataSourceStatus", "traits": { - "smithy.api#documentation": "

The current status of the data source connector. When the Status field\n value is FAILED, the ErrorMessage field contains a description\n of the error that caused the data source connector to fail.

" + "smithy.api#documentation": "

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" } }, "syncSchedule": { @@ -7127,14 +7425,14 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access the data source\n and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

" } }, "error": { "target": "com.amazonaws.qbusiness#ErrorDetail", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the\n data source connector to fail.

" + "smithy.api#documentation": "

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" } }, "documentEnrichmentConfiguration": { @@ -7143,7 +7441,7 @@ "mediaExtractionConfiguration": { "target": "com.amazonaws.qbusiness#MediaExtractionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for extracting information from media in documents for the data source.\n

" + "smithy.api#documentation": "

The configuration for extracting information from media in documents for the data source.

" } } }, @@ -7338,7 +7636,7 @@ "status": { "target": "com.amazonaws.qbusiness#IndexStatus", "traits": { - "smithy.api#documentation": "

The current status of the index. When the value is ACTIVE, the index is\n ready for use. If the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" + "smithy.api#documentation": "

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

" } }, "type": { @@ -7374,14 +7672,14 @@ "documentAttributeConfigurations": { "target": "com.amazonaws.qbusiness#DocumentAttributeConfigurations", "traits": { - "smithy.api#documentation": "

Configuration information for document attributes or metadata. Document metadata are\n fields associated with your documents. For example, the company department name\n associated with each document. For more information, see Understanding document attributes.

" + "smithy.api#documentation": "

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

" } }, "error": { "target": "com.amazonaws.qbusiness#ErrorDetail", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" + "smithy.api#documentation": "

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

" } }, "indexStatistics": { @@ -7427,7 +7725,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and\n have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download \n the images so you can show them in your UI with responses.

\n

For more information, see Extracting semantic meaning from images and visuals.

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

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.

For more information, see Extracting semantic meaning from images and visuals.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/media/{mediaId}" @@ -7607,7 +7905,7 @@ "pluginArn": { "target": "com.amazonaws.qbusiness#PluginArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access resources needed\n to create the plugin.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

" } }, "state": { @@ -7659,7 +7957,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the current permission policy for a Amazon Q Business application. The policy is \n returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

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

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

", "smithy.api#http": { "uri": "/applications/{applicationId}/policy", "method": "GET" @@ -7726,7 +8024,7 @@ "aws.iam#requiredActions": [ "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Gets information about an existing retriever used by an Amazon Q Business\n application.

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

Gets information about an existing retriever used by an Amazon Q Business application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -7803,7 +8101,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the retriever\n and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

" } }, "createdAt": { @@ -7852,7 +8150,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the universally unique identifier (UUID) associated with a local user in a\n data source.

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

Describes the universally unique identifier (UUID) associated with a local user in a data source.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/users/{userId}" @@ -7977,7 +8275,7 @@ "webExperienceArn": { "target": "com.amazonaws.qbusiness#WebExperienceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q Business web experience and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

" } }, "defaultEndpoint": { @@ -7989,7 +8287,7 @@ "status": { "target": "com.amazonaws.qbusiness#WebExperienceStatus", "traits": { - "smithy.api#documentation": "

The current status of the Amazon Q Business web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.

" + "smithy.api#documentation": "

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" } }, "createdAt": { @@ -8019,31 +8317,31 @@ "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q Business web\n experience.

" + "smithy.api#documentation": "

The customized welcome message for end users of an Amazon Q Business web experience.

" } }, "samplePromptsControlMode": { "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", "traits": { - "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end user.

" } }, "origins": { "target": "com.amazonaws.qbusiness#WebExperienceOrigins", "traits": { - "smithy.api#documentation": "

Gets the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).\n

" + "smithy.api#documentation": "

Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role attached to your web\n experience.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role attached to your web experience.

" } }, "identityProviderConfiguration": { "target": "com.amazonaws.qbusiness#IdentityProviderConfiguration", "traits": { - "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an\n Amazon Q Business web experience.

" + "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "authenticationConfiguration": { @@ -8052,14 +8350,14 @@ "smithy.api#deprecated": { "message": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." }, - "smithy.api#documentation": "

The authentication configuration information for your Amazon Q Business web\n experience.

" + "smithy.api#documentation": "

The authentication configuration information for your Amazon Q Business web experience.

" } }, "error": { "target": "com.amazonaws.qbusiness#ErrorDetail", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the\n data source connector to fail.

" + "smithy.api#documentation": "

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

" } }, "browserExtensionConfiguration": { @@ -8071,7 +8369,7 @@ "customizationConfiguration": { "target": "com.amazonaws.qbusiness#CustomizationConfiguration", "traits": { - "smithy.api#documentation": "

Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.\n

" + "smithy.api#documentation": "

Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

" } } }, @@ -8095,13 +8393,13 @@ "memberGroups": { "target": "com.amazonaws.qbusiness#MemberGroups", "traits": { - "smithy.api#documentation": "

A list of sub groups that belong to a group. For example, the sub groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\" all belong to the group \"Company\".

" + "smithy.api#documentation": "

A list of sub groups that belong to a group. For example, the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\" all belong to the group \"Company\".

" } }, "memberUsers": { "target": "com.amazonaws.qbusiness#MemberUsers", "traits": { - "smithy.api#documentation": "

A list of users that belong to a group. For example, a list of interns all belong to\n the \"Interns\" group.

" + "smithy.api#documentation": "

A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.

" } }, "s3PathForGroupMembers": { @@ -8109,7 +8407,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of users or sub groups that belong to a group. This is for generating\n Amazon Q Business chat results only from document a user has access to.

" + "smithy.api#documentation": "

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

" } }, "com.amazonaws.qbusiness#GroupName": { @@ -8209,36 +8507,67 @@ "target": "com.amazonaws.qbusiness#GroupSummary" } }, + "com.amazonaws.qbusiness#HallucinationReductionConfiguration": { + "type": "structure", + "members": { + "hallucinationReductionControl": { + "target": "com.amazonaws.qbusiness#HallucinationReductionControl", + "traits": { + "smithy.api#documentation": "

Controls whether hallucination reduction has been enabled or disabled for your application. The default status is DISABLED.

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

Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.

The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.

" + } + }, + "com.amazonaws.qbusiness#HallucinationReductionControl": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.qbusiness#HookConfiguration": { "type": "structure", "members": { "invocationCondition": { "target": "com.amazonaws.qbusiness#DocumentAttributeCondition", "traits": { - "smithy.api#documentation": "

The condition used for when a Lambda function should be invoked.

\n

For example, you can specify a condition that if there are empty date-time values,\n then Amazon Q Business should invoke a function that inserts the current date-time.

" + "smithy.api#documentation": "

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

" } }, "lambdaArn": { "target": "com.amazonaws.qbusiness#LambdaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run a Lambda\n function during ingestion. For more information, see IAM roles for\n Custom Document Enrichment (CDE).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.

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

Stores the original, raw documents or the structured, parsed documents before and\n after altering them. For more information, see Data contracts for Lambda functions.

" + "smithy.api#documentation": "

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run\n PreExtractionHookConfiguration and\n PostExtractionHookConfiguration for altering document metadata and\n content during the document ingestion process.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

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

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.

\n

You can configure your Lambda function using the\n PreExtractionHookConfiguration parameter if you want to apply advanced\n alterations on the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using\n PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#IAMIdentityProviderArn": { @@ -8274,7 +8603,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services\n on your behalf.

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

The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.

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

Provides information about the identity provider (IdP) used to authenticate end users\n of an Amazon Q Business web experience.

" + "smithy.api#documentation": "

Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "com.amazonaws.qbusiness#IdentityType": { @@ -8408,7 +8737,7 @@ "status": { "target": "com.amazonaws.qbusiness#IndexStatus", "traits": { - "smithy.api#documentation": "

The current status of the index. When the status is ACTIVE, the index is\n ready.

" + "smithy.api#documentation": "

The current status of the index. When the status is ACTIVE, the index is ready.

" } } }, @@ -8604,12 +8933,12 @@ "documentContentOperator": { "target": "com.amazonaws.qbusiness#DocumentContentOperator", "traits": { - "smithy.api#documentation": "

\n TRUE to delete content if the condition used for the target attribute is\n met.

" + "smithy.api#documentation": "

TRUE to delete content if the condition used for the target attribute is met.

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

Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q Business.

\n

To apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .

\n

For more information, see Custom document enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations": { @@ -8674,7 +9003,7 @@ } }, "traits": { - "smithy.api#documentation": "

An issue occurred with the internal server used for your Amazon Q Business service. Wait\n some minutes and try again, or contact Support for help.

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

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -8735,7 +9064,7 @@ } }, "traits": { - "smithy.api#documentation": "

You don't have permissions to perform the action because your license is inactive. Ask\n your admin to activate your license and try again after your licence is active.

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

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8763,7 +9092,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Amazon Q Business applications.

\n \n

Amazon Q Business applications may securely transmit data for processing across\n Amazon Web Services Regions within your geography. For more information, see\n Cross region\n inference in Amazon Q Business.

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

Lists Amazon Q Business applications.

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

", "smithy.api#http": { "uri": "/applications", "method": "GET" @@ -8783,7 +9112,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business applications.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

", "smithy.api#httpQuery": "nextToken" } }, @@ -8805,13 +9134,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.

" } }, "applications": { "target": "com.amazonaws.qbusiness#Applications", "traits": { - "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q Business\n applications.

" + "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q Business applications.

" } } }, @@ -8890,7 +9219,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of attachments returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of attachments.

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

If the number of attachments returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.

", "smithy.api#httpQuery": "nextToken" } }, @@ -8918,7 +9247,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of attachments.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments.

" } } }, @@ -8983,14 +9312,14 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "

The identifier of the user involved in the Amazon Q Business web experience conversation.\n

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

The identifier of the user involved in the Amazon Q Business web experience conversation.

", "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9012,13 +9341,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

" } }, "conversations": { "target": "com.amazonaws.qbusiness#Conversations", "traits": { - "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q Business web\n experiences.

" + "smithy.api#documentation": "

An array of summary information on the configuration of one or more Amazon Q Business web experiences.

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

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated \n list of data accessor summaries, including the friendly name, unique identifier, ARN, \n associated IAM role, and creation/update timestamps for each data accessor.

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

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

", "smithy.api#http": { "uri": "/applications/{applicationId}/dataaccessors", "method": "GET" @@ -9189,7 +9518,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.

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

If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9217,7 +9546,7 @@ "statusFilter": { "target": "com.amazonaws.qbusiness#DataSourceSyncJobStatus", "traits": { - "smithy.api#documentation": "

Only returns synchronization jobs with the Status field equal to the\n specified status.

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

Only returns synchronization jobs with the Status field equal to the specified status.

", "smithy.api#httpQuery": "syncStatus" } } @@ -9238,7 +9567,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.

" } } }, @@ -9292,7 +9621,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to the data source\n connectors.

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

The identifier of the Amazon Q Business application linked to the data source connectors.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9308,7 +9637,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business data source\n connectors.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9336,7 +9665,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.

" } } }, @@ -9413,7 +9742,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9441,7 +9770,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.

" + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

" } } }, @@ -9514,7 +9843,7 @@ "updatedEarlierThan": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp identifier used for the latest PUT or DELETE\n action for mapping users to their groups.

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

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

", "smithy.api#httpQuery": "updatedEarlierThan", "smithy.api#required": {} } @@ -9529,7 +9858,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.

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

If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9551,7 +9880,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.

" } }, "items": { @@ -9619,7 +9948,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q Business indices.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9641,7 +9970,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.

" } }, "indices": { @@ -9720,14 +10049,14 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "

The identifier of the user involved in the Amazon Q Business web experience\n conversation.

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

The identifier of the user involved in the Amazon Q Business web experience conversation.

", "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of messages returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of messages.

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

If the number of messages returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9755,7 +10084,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

" } } }, @@ -9809,7 +10138,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the plugin is attached\n to.

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

The identifier of the Amazon Q Business application the plugin is attached to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9825,7 +10154,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set\n of plugin actions.

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

If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9847,7 +10176,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugin actions.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.

" } }, "items": { @@ -9884,7 +10213,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists configured Amazon Q Business actions for any plugin type\u2014both\n built-in and custom.

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

Lists configured Amazon Q Business actions for any plugin type\u2014both built-in and custom.

", "smithy.api#http": { "method": "GET", "uri": "/pluginTypes/{pluginType}/actions" @@ -9912,7 +10241,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set\n of plugins.

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

If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.

", "smithy.api#httpQuery": "nextToken" } }, @@ -9934,7 +10263,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugins.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.

" } }, "items": { @@ -9991,7 +10320,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the metadata returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of metadata.

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

If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10013,7 +10342,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you\n can use in a later request to list the next set of plugin metadata.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.

" } }, "items": { @@ -10087,7 +10416,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10109,7 +10438,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.

" + "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

" } }, "plugins": { @@ -10177,7 +10506,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the number of retrievers returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of\n retrievers.

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

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10205,7 +10534,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of retrievers.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.

" } } }, @@ -10270,7 +10599,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business subscriptions.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10292,13 +10621,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of subscriptions.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.

" } }, "subscriptions": { "target": "com.amazonaws.qbusiness#Subscriptions", "traits": { - "smithy.api#documentation": "

An array of summary information on the subscriptions configured for an Amazon Q Business\n application.

" + "smithy.api#documentation": "

An array of summary information on the subscriptions configured for an Amazon Q Business application.

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

Gets a list of tags associated with a specified resource. Amazon Q Business applications\n and data sources can have tags associated with them.

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

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "GET" @@ -10346,7 +10675,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get\n a list of tags for.

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

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10416,7 +10745,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to the listed web\n experiences.

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

The identifier of the Amazon Q Business application linked to the listed web experiences.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10424,7 +10753,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.

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

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

", "smithy.api#httpQuery": "nextToken" } }, @@ -10452,7 +10781,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.

" + "smithy.api#documentation": "

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.

" } } }, @@ -10644,7 +10973,7 @@ "imageExtractionConfiguration": { "target": "com.amazonaws.qbusiness#ImageExtractionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for extracting semantic meaning from images in documents. \n For more information, see Extracting semantic meaning from images and visuals.

" + "smithy.api#documentation": "

The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.

" } }, "audioExtractionConfiguration": { @@ -10802,7 +11131,7 @@ "type": { "target": "com.amazonaws.qbusiness#MessageType", "traits": { - "smithy.api#documentation": "

The type of Amazon Q Business message, whether HUMAN or AI\n generated.

" + "smithy.api#documentation": "

The type of Amazon Q Business message, whether HUMAN or AI generated.

" } }, "attachments": { @@ -10911,7 +11240,7 @@ "comment": { "target": "com.amazonaws.qbusiness#MessageUsefulnessComment", "traits": { - "smithy.api#documentation": "

A comment given by an end user on the usefulness of an AI-generated chat\n message.

" + "smithy.api#documentation": "

A comment given by an end user on the usefulness of an AI-generated chat message.

" } }, "submittedAt": { @@ -11015,19 +11344,19 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "

The identifier of the conversation with which the generated metadata is\n associated.

" + "smithy.api#documentation": "

The identifier of the conversation with which the generated metadata is associated.

" } }, "userMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "

The identifier of an Amazon Q Business end user text input message within the\n conversation.

" + "smithy.api#documentation": "

The identifier of an Amazon Q Business end user text input message within the conversation.

" } }, "systemMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated message within the\n conversation.

" + "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated message within the conversation.

" } }, "sourceAttributions": { @@ -11044,7 +11373,7 @@ } }, "traits": { - "smithy.api#documentation": "

A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation, containing associated metadata generated.

" + "smithy.api#documentation": "

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

" } }, "com.amazonaws.qbusiness#MetricValue": { @@ -11066,7 +11395,7 @@ "boostingOverride": { "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingOverrideMap", "traits": { - "smithy.api#documentation": "

Overrides the default boosts applied by Amazon Q Business to supported document attribute\n data types.

" + "smithy.api#documentation": "

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

" } } }, @@ -11096,7 +11425,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Information about invoking a custom plugin without any authentication or authorization\n requirement.

" + "smithy.api#documentation": "

Information about invoking a custom plugin without any authentication or authorization requirement.

" } }, "com.amazonaws.qbusiness#NumberAttributeBoostingConfiguration": { @@ -11105,7 +11434,7 @@ "boostingLevel": { "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel", "traits": { - "smithy.api#documentation": "

Specifies the duration, in seconds, of a boost applies to a NUMBER type\n document attribute.

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

Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

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

Provides information on boosting NUMBER type document attributes.

\n

For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.

" + "smithy.api#documentation": "

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

" } }, "com.amazonaws.qbusiness#NumberAttributeBoostingType": { @@ -11143,32 +11472,32 @@ "secretArn": { "target": "com.amazonaws.qbusiness#SecretArn", "traits": { - "smithy.api#documentation": "

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token\n used for plugin configuration.

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

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.

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

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

", "smithy.api#required": {} } }, "authorizationUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to\n authenticate a plugin user through a third party authentication server.

" + "smithy.api#documentation": "

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

" } }, "tokenUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code\n for an access token.

" + "smithy.api#documentation": "

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

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

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

" + "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" } }, "com.amazonaws.qbusiness#OpenIDConnectProviderConfiguration": { @@ -11177,20 +11506,20 @@ "secretsArn": { "target": "com.amazonaws.qbusiness#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC\n client secret.

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

The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.

", "smithy.api#required": {} } }, "secretsRole": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

An IAM role with permissions to access KMS to decrypt\n the Secrets Manager secret containing your OIDC client secret.

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

An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.

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

Information about the OIDC-compliant identity provider (IdP) used to authenticate end\n users of an Amazon Q Business web experience.

" + "smithy.api#documentation": "

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "com.amazonaws.qbusiness#OrchestrationConfiguration": { @@ -11199,13 +11528,13 @@ "control": { "target": "com.amazonaws.qbusiness#OrchestrationControl", "traits": { - "smithy.api#documentation": "

Status information about whether chat orchestration is activated or deactivated for\n your Amazon Q Business application.

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

Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.

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

Configuration information required to enable chat orchestration for your Amazon Q Business\n application.

\n \n

Chat orchestration is optimized to work for English language content. For more\n details on language support in Amazon Q Business, see Supported languages.

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

Configuration information required to enable chat orchestration for your Amazon Q Business application.

Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

" } }, "com.amazonaws.qbusiness#OrchestrationControl": { @@ -11247,13 +11576,13 @@ "personalizationControlMode": { "target": "com.amazonaws.qbusiness#PersonalizationControlMode", "traits": { - "smithy.api#documentation": "

An option to allow Amazon Q Business to customize chat responses using user\n specific metadata\u2014specifically, location and job information\u2014in your\n IAM Identity Center instance.

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

An option to allow Amazon Q Business to customize chat responses using user specific metadata\u2014specifically, location and job information\u2014in your IAM Identity Center instance.

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

Configuration information about chat response personalization. For more information,\n see Personalizing chat responses.

" + "smithy.api#documentation": "

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

" } }, "com.amazonaws.qbusiness#PersonalizationControlMode": { @@ -11345,13 +11674,13 @@ "basicAuthConfiguration": { "target": "com.amazonaws.qbusiness#BasicAuthConfiguration", "traits": { - "smithy.api#documentation": "

Information about the basic authentication credentials used to configure a\n plugin.

" + "smithy.api#documentation": "

Information about the basic authentication credentials used to configure a plugin.

" } }, "oAuth2ClientCredentialConfiguration": { "target": "com.amazonaws.qbusiness#OAuth2ClientCredentialConfiguration", "traits": { - "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

" + "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" } }, "noAuthConfiguration": { @@ -11430,7 +11759,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information required to invoke chat in PLUGIN_MODE.

\n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" + "smithy.api#documentation": "

Configuration information required to invoke chat in PLUGIN_MODE.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

" } }, "com.amazonaws.qbusiness#PluginDescription": { @@ -11670,7 +11999,7 @@ "description": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "

The description assigned by Amazon Q Business to a plugin. You can't\n modify this value.

" + "smithy.api#documentation": "

The description assigned by Amazon Q Business to a plugin. You can't modify this value.

" } } }, @@ -11701,7 +12030,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides user and group information used for filtering documents to use for generating\n Amazon Q Business conversation responses.

" + "smithy.api#documentation": "

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

" } }, "com.amazonaws.qbusiness#PrincipalGroup": { @@ -11800,7 +12129,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables your end user to provide feedback on their Amazon Q Business generated chat\n responses.

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

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", "method": "POST" @@ -11890,7 +12219,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create, or updates, a mapping of users\u2014who have access to a document\u2014to\n groups.

\n

You can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q Business chat results.

\n

There are two options for creating groups, either passing group members inline or using an S3 file via the\n S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files\n there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both\n an S3 file and a RoleArn for Amazon Q Buisness to access the file.

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

Create, or updates, a mapping of users\u2014who have access to a document\u2014to groups.

You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/indices/{indexId}/groups" @@ -11920,14 +12249,14 @@ "groupName": { "target": "com.amazonaws.qbusiness#GroupName", "traits": { - "smithy.api#documentation": "

The list that contains your users or sub groups that belong the same group. For\n example, the group \"Company\" includes the user \"CEO\" and the sub groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\".

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

The list that contains your users or sub groups that belong the same group. For example, the group \"Company\" includes the user \"CEO\" and the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\".

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "

The identifier of the data source for which you want to map users to their groups.\n This is useful if a group is tied to multiple data sources, but you only want the group\n to access documents of a certain data source. For example, the groups \"Research\",\n \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored\n in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only\n needs access to customer-related documents stored in Salesforce.

" + "smithy.api#documentation": "

The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only needs access to customer-related documents stored in Salesforce.

" } }, "type": { @@ -11946,7 +12275,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains \n your list of users that belong to a group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

" } } }, @@ -11967,7 +12296,7 @@ "qAppsControlMode": { "target": "com.amazonaws.qbusiness#QAppsControlMode", "traits": { - "smithy.api#documentation": "

Status information about whether end users can create and use Amazon Q Apps in the web\n experience.

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

Status information about whether end users can create and use Amazon Q Apps in the web experience.

", "smithy.api#required": {} } } @@ -12020,13 +12349,13 @@ "clientNamespace": { "target": "com.amazonaws.qbusiness#ClientNamespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see \n Namespace operations.\n

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

The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.

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

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.\n For more information, see Creating an\n Amazon QuickSight integrated application.

" + "smithy.api#documentation": "

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

" } }, "com.amazonaws.qbusiness#ReadAccessType": { @@ -12122,7 +12451,7 @@ } }, "traits": { - "smithy.api#documentation": "

The application or plugin resource you want to use doesn\u2019t exist. Make sure you have\n provided the correct resource and try again.

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

The application or plugin resource you want to use doesn\u2019t exist. Make sure you have provided the correct resource and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -12198,18 +12527,18 @@ "nativeIndexConfiguration": { "target": "com.amazonaws.qbusiness#NativeIndexConfiguration", "traits": { - "smithy.api#documentation": "

Provides information on how a Amazon Q Business index used as a retriever for your\n Amazon Q Business application is configured.

" + "smithy.api#documentation": "

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

" } }, "kendraIndexConfiguration": { "target": "com.amazonaws.qbusiness#KendraIndexConfiguration", "traits": { - "smithy.api#documentation": "

Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q Business application is configured.

" + "smithy.api#documentation": "

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

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

Provides information on how the retriever used for your Amazon Q Business application is\n configured.

" + "smithy.api#documentation": "

Provides information on how the retriever used for your Amazon Q Business application is configured.

" } }, "com.amazonaws.qbusiness#RetrieverContentSource": { @@ -12364,7 +12693,7 @@ } }, "traits": { - "smithy.api#documentation": "

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule\n at a time.

" + "smithy.api#documentation": "

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

" } }, "com.amazonaws.qbusiness#RuleConfiguration": { @@ -12373,7 +12702,7 @@ "contentBlockerRule": { "target": "com.amazonaws.qbusiness#ContentBlockerRule", "traits": { - "smithy.api#documentation": "

A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic.

" + "smithy.api#documentation": "

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

" } }, "contentRetrievalRule": { @@ -12431,7 +12760,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information required for Amazon Q Business to find a specific file in an Amazon S3\n bucket.

" + "smithy.api#documentation": "

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

" } }, "com.amazonaws.qbusiness#S3BucketName": { @@ -12485,7 +12814,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q Business web experience, containing the relevant\n Amazon Q Business permissions for conversing with Amazon Q Business.

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

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

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

Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q Business needs to deploy a Amazon Q Business web experience.

" + "smithy.api#documentation": "

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

" } }, "com.amazonaws.qbusiness#SamlMetadataXML": { @@ -12523,13 +12852,13 @@ "authenticationUrl": { "target": "com.amazonaws.qbusiness#SamlAuthenticationUrl", "traits": { - "smithy.api#documentation": "

The URL where Amazon Q Business end users will be redirected for authentication.\n

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

The URL where Amazon Q Business end users will be redirected for authentication.

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

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate\n end users of an Amazon Q Business web experience.

" + "smithy.api#documentation": "

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "com.amazonaws.qbusiness#ScoreAttributes": { @@ -12610,7 +12939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a \n search query text, the Amazon Q Business application identifier, and optional filters \n (such as content source and maximum results) as input. It returns a list of \n relevant content items, where each item includes the content text, the unique document identifier, \n the document title, the document URI, any relevant document attributes, and score attributes \n indicating the confidence level of the relevance.

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

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

", "smithy.api#http": { "uri": "/applications/{applicationId}/relevant-content", "method": "POST" @@ -12757,12 +13086,12 @@ "text": { "target": "com.amazonaws.qbusiness#SnippetExcerptText", "traits": { - "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q chat response.

" + "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.

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

Contains the relevant text excerpt from a source that was used to generate a citation\n text segment in an Amazon Q Business chat response.

" + "smithy.api#documentation": "

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

" } }, "com.amazonaws.qbusiness#SnippetExcerptText": { @@ -12774,19 +13103,19 @@ "title": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "

The title of the document which is the source for the Amazon Q Business generated\n response.

" + "smithy.api#documentation": "

The title of the document which is the source for the Amazon Q Business generated response.

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

The content extract from the document on which the generated response is based.\n

" + "smithy.api#documentation": "

The content extract from the document on which the generated response is based.

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

The URL of the document which is the source for the Amazon Q Business generated response.\n

" + "smithy.api#documentation": "

The URL of the document which is the source for the Amazon Q Business generated response.

" } }, "citationNumber": { @@ -12889,7 +13218,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q Business returns a ConflictException.

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

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync", "method": "POST" @@ -12998,7 +13327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an Amazon Q Business data source connector synchronization job already in\n progress.

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

Stops an Amazon Q Business data source connector synchronization job already in progress.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", "method": "POST" @@ -13019,7 +13348,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application that the data source is connected\n to.

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

The identifier of the Amazon Q Business application that the data source is connected to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13066,12 +13395,12 @@ "attributeValueBoosting": { "target": "com.amazonaws.qbusiness#StringAttributeValueBoosting", "traits": { - "smithy.api#documentation": "

Specifies specific values of a STRING type document attribute being\n boosted.

" + "smithy.api#documentation": "

Specifies specific values of a STRING type document attribute being boosted.

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

Provides information on boosting STRING type document attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.

" + "smithy.api#documentation": "

Provides information on boosting STRING type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

" } }, "com.amazonaws.qbusiness#StringAttributeValueBoosting": { @@ -13130,7 +13459,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information on boosting STRING_LIST type document\n attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.

" + "smithy.api#documentation": "

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

" } }, "com.amazonaws.qbusiness#SubnetId": { @@ -13161,13 +13490,13 @@ "subscriptionArn": { "target": "com.amazonaws.qbusiness#SubscriptionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was\n updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

" } }, "principal": { "target": "com.amazonaws.qbusiness#SubscriptionPrincipal", "traits": { - "smithy.api#documentation": "

The IAM Identity Center UserId or GroupId of a user or group\n in the IAM Identity Center instance connected to the Amazon Q Business application.

" + "smithy.api#documentation": "

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

" } }, "currentSubscription": { @@ -13184,7 +13513,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an Amazon Q Business subscription.

\n

Subscriptions are used to provide access for an IAM Identity Center user or a group to\n an Amazon Q Business application.

\n

Amazon Q Business offers two subscription tiers: Q_LITE and\n Q_BUSINESS. Subscription tier determines feature access for the user.\n For more information on subscriptions and pricing tiers, see Amazon Q Business\n pricing.

" + "smithy.api#documentation": "

Information about an Amazon Q Business subscription.

Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

" } }, "com.amazonaws.qbusiness#SubscriptionArn": { @@ -13226,18 +13555,18 @@ "user": { "target": "com.amazonaws.qbusiness#UserIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of a user in the IAM Identity Center instance connected to the\n Amazon Q Business application.

" + "smithy.api#documentation": "

The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.

" } }, "group": { "target": "com.amazonaws.qbusiness#GroupIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of a group in the IAM Identity Center instance connected to the\n Amazon Q Business application.

" + "smithy.api#documentation": "

The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.

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

A user or group in the IAM Identity Center instance connected to the Amazon Q Business\n application.

" + "smithy.api#documentation": "

A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

" } }, "com.amazonaws.qbusiness#SubscriptionType": { @@ -13291,26 +13620,43 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.qbusiness#SystemMessageType": { + "type": "enum", + "members": { + "RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE" + } + }, + "GROUNDED_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUNDED_RESPONSE" + } + } + } + }, "com.amazonaws.qbusiness#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.qbusiness#TagKey", "traits": { - "smithy.api#documentation": "

The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q Business application or data source.

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

The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

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

The value associated with the tag. The value may be an empty string but it can't be\n null.

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

The value associated with the tag. The value may be an empty string but it can't be null.

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

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and\n values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

" } }, "com.amazonaws.qbusiness#TagKey": { @@ -13367,7 +13713,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Adds the specified tag to the specified Amazon Q Business application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.

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

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "POST" @@ -13381,7 +13727,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to\n tag.

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

The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13389,7 +13735,7 @@ "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { - "smithy.api#documentation": "

A list of tag keys to add to the Amazon Q Business application or data source. If a tag\n already exists, the existing value is replaced with the new value.

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

A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.

", "smithy.api#required": {} } } @@ -13464,10 +13810,16 @@ "com.amazonaws.qbusiness#TextOutputEvent": { "type": "structure", "members": { + "systemMessageType": { + "target": "com.amazonaws.qbusiness#SystemMessageType", + "traits": { + "smithy.api#documentation": "

The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

" + } + }, "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "

The identifier of the conversation with which the text output event is\n associated.

" + "smithy.api#documentation": "

The identifier of the conversation with which the text output event is associated.

" } }, "userMessageId": { @@ -13490,7 +13842,7 @@ } }, "traits": { - "smithy.api#documentation": "

An output event for an AI-generated response in an Amazon Q Business web\n experience.

" + "smithy.api#documentation": "

An output event for an AI-generated response in an Amazon Q Business web experience.

" } }, "com.amazonaws.qbusiness#TextSegment": { @@ -13499,19 +13851,19 @@ "beginOffset": { "target": "com.amazonaws.qbusiness#Integer", "traits": { - "smithy.api#documentation": "

The zero-based location in the response string where the source attribution\n starts.

" + "smithy.api#documentation": "

The zero-based location in the response string where the source attribution starts.

" } }, "endOffset": { "target": "com.amazonaws.qbusiness#Integer", "traits": { - "smithy.api#documentation": "

The zero-based location in the response string where the source attribution\n ends.

" + "smithy.api#documentation": "

The zero-based location in the response string where the source attribution ends.

" } }, "snippetExcerpt": { "target": "com.amazonaws.qbusiness#SnippetExcerpt", "traits": { - "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q Business chat response.

" + "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

" } }, "mediaId": { @@ -13542,7 +13894,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about a text extract in a chat response that can be attributed to\n a source document.

" + "smithy.api#documentation": "

Provides information about a text extract in a chat response that can be attributed to a source document.

" } }, "com.amazonaws.qbusiness#TextSegmentList": { @@ -13562,7 +13914,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied due to throttling. Reduce the number of requests and try\n again.

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

The request was denied due to throttling. Reduce the number of requests and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -13592,13 +13944,13 @@ "description": { "target": "com.amazonaws.qbusiness#TopicDescription", "traits": { - "smithy.api#documentation": "

A description for your topic control configuration. Use this to outline how the large\n language model (LLM) should use this topic control configuration.

" + "smithy.api#documentation": "

A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

" } }, "exampleChatMessages": { "target": "com.amazonaws.qbusiness#ExampleChatMessages", "traits": { - "smithy.api#documentation": "

A list of example phrases that you expect the end user to use in relation to the\n topic.

" + "smithy.api#documentation": "

A list of example phrases that you expect the end user to use in relation to the topic.

" } }, "rules": { @@ -13687,7 +14039,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to\n remove the tag from.

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

The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13695,7 +14047,7 @@ "tagKeys": { "target": "com.amazonaws.qbusiness#TagKeys", "traits": { - "smithy.api#documentation": "

A list of tag keys to remove from the Amazon Q Business application or data source. If a\n tag key does not exist on the resource, it is ignored.

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

A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -13754,7 +14106,7 @@ "sso:DeleteApplication", "sso:DescribeInstance" ], - "smithy.api#documentation": "

Updates an existing Amazon Q Business application.

\n \n

Amazon Q Business applications may securely transmit data for processing across\n Amazon Web Services Regions within your geography. For more information, see\n Cross region\n inference in Amazon Q Business.

\n \n \n

An Amazon Q Apps service-linked role will be created if it's absent in the\n Amazon Web Services account when QAppsConfiguration is enabled in\n the request. For more information, see Using\n service-linked roles for Q Apps.

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

Updates an existing Amazon Q Business application.

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "PUT" @@ -13776,7 +14128,7 @@ "identityCenterInstanceArn": { "target": "com.amazonaws.qbusiness#InstanceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for\u2014or connecting to\u2014your Amazon Q Business application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for\u2014or connecting to\u2014your Amazon Q Business application.

" } }, "displayName": { @@ -13794,7 +14146,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q Business permission to access Amazon CloudWatch logs and\n metrics.

" + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.

" } }, "attachmentsConfiguration": { @@ -13806,19 +14158,19 @@ "qAppsConfiguration": { "target": "com.amazonaws.qbusiness#QAppsConfiguration", "traits": { - "smithy.api#documentation": "

An option to allow end users to create and use Amazon Q Apps in the web\n experience.

" + "smithy.api#documentation": "

An option to allow end users to create and use Amazon Q Apps in the web experience.

" } }, "personalizationConfiguration": { "target": "com.amazonaws.qbusiness#PersonalizationConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information about chat response personalization. For more information,\n see Personalizing chat responses.

" + "smithy.api#documentation": "

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

" } }, "autoSubscriptionConfiguration": { "target": "com.amazonaws.qbusiness#AutoSubscriptionConfiguration", "traits": { - "smithy.api#documentation": "

An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user\n management.

" + "smithy.api#documentation": "

An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

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

Updates a set of chat controls configured for an existing Amazon Q Business\n application.

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

Updates a set of chat controls configured for an existing Amazon Q Business application.

", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "PATCH", @@ -13888,14 +14240,14 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to update a Amazon Q Business application\n chat configuration.

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

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

", "smithy.api#idempotencyToken": {} } }, "responseScope": { "target": "com.amazonaws.qbusiness#ResponseScope", "traits": { - "smithy.api#documentation": "

The response scope configured for your application. This determines whether your\n application uses its retrieval augmented generation (RAG) system to generate answers\n only from your enterprise data, or also uses the large language models (LLM) knowledge\n to respons to end user questions in chat.

" + "smithy.api#documentation": "

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

" } }, "orchestrationConfiguration": { @@ -13927,6 +14279,12 @@ "traits": { "smithy.api#documentation": "

The configuration details for CREATOR_MODE.

" } + }, + "hallucinationReductionConfiguration": { + "target": "com.amazonaws.qbusiness#HallucinationReductionConfiguration", + "traits": { + "smithy.api#documentation": "

The hallucination reduction settings for your application.

" + } } }, "traits": { @@ -13975,7 +14333,7 @@ "qbusiness:UntagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Updates an existing data accessor. This operation allows modifying the action configurations \n (the allowed actions and associated filters) and the display name of the data accessor. \n It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

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

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

", "smithy.api#http": { "uri": "/applications/{applicationId}/dataaccessors/{dataAccessorId}", "method": "PUT" @@ -14077,7 +14435,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application the data source is attached\n to.

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

The identifier of the Amazon Q Business application the data source is attached to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14125,7 +14483,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access\n the data source and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" } }, "documentEnrichmentConfiguration": { @@ -14229,13 +14587,13 @@ "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "

The storage capacity units you want to provision for your Amazon Q Business index. You can\n add and remove capacity to fit your usage needs.

" + "smithy.api#documentation": "

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

" } }, "documentAttributeConfigurations": { "target": "com.amazonaws.qbusiness#DocumentAttributeConfigurations", "traits": { - "smithy.api#documentation": "

Configuration information for document metadata or fields. Document metadata are\n fields or attributes associated with your documents. For example, the company department\n name associated with each document. For more information, see Understanding document attributes.

" + "smithy.api#documentation": "

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

" } } }, @@ -14436,7 +14794,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever\n and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

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

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant.\n Downgrades apply at the start of the next month. Subscription tier determines feature\n access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business\n pricing.

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

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/subscriptions/{subscriptionId}" @@ -14494,7 +14852,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q Business application where the subscription update should\n take effect.

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

The identifier of the Amazon Q Business application where the subscription update should take effect.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14525,7 +14883,7 @@ "subscriptionArn": { "target": "com.amazonaws.qbusiness#SubscriptionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was\n updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

" } }, "currentSubscription": { @@ -14557,6 +14915,9 @@ { "target": "com.amazonaws.qbusiness#AccessDeniedException" }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, { "target": "com.amazonaws.qbusiness#InternalServerException" }, @@ -14712,7 +15073,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business\n web experience and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

" } }, "authenticationConfiguration": { @@ -14739,31 +15100,31 @@ "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "

A customized welcome message for an end user in an Amazon Q Business web\n experience.

" + "smithy.api#documentation": "

A customized welcome message for an end user in an Amazon Q Business web experience.

" } }, "samplePromptsControlMode": { "target": "com.amazonaws.qbusiness#WebExperienceSamplePromptsControlMode", "traits": { - "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" + "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end user.

" } }, "identityProviderConfiguration": { "target": "com.amazonaws.qbusiness#IdentityProviderConfiguration", "traits": { - "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an\n Amazon Q Business web experience.

" + "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

" } }, "origins": { "target": "com.amazonaws.qbusiness#WebExperienceOrigins", "traits": { - "smithy.api#documentation": "

Updates the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).

\n \n
    \n
  • \n

    Any values except null submitted as part of this \n update will replace all previous values.

    \n
    • \n
  • \n

    You must only submit a base URL and \n not a full path. For example, https://docs.aws.amazon.com.

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

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

  • Any values except null submitted as part of this update will replace all previous values.

  • You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

" } }, "browserExtensionConfiguration": { "target": "com.amazonaws.qbusiness#BrowserExtensionConfiguration", "traits": { - "smithy.api#documentation": "

The browser extension configuration for an Amazon Q Business web experience.

\n \n

\n For Amazon Q Business application using external OIDC-compliant identity providers (IdPs).\n The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application.\n For more information, see Configure external OIDC identity provider for your browser extensions..\n

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

The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

" } }, "customizationConfiguration": { @@ -14879,7 +15240,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about users and group names associated with a topic control\n rule.

" + "smithy.api#documentation": "

Provides information about users and group names associated with a topic control rule.

" } }, "com.amazonaws.qbusiness#ValidationException": { @@ -14907,7 +15268,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the\n correct input and try again.

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

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14931,7 +15292,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input failed to meet the constraints specified by Amazon Q Business in a specified\n field.

" + "smithy.api#documentation": "

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

" } }, "com.amazonaws.qbusiness#ValidationExceptionFields": { @@ -15074,7 +15435,7 @@ "defaultEndpoint": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully\n hosted by Amazon Web Services.

" + "smithy.api#documentation": "

The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.

" } }, "status": { @@ -15106,7 +15467,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the authorization configuration information needed to deploy a Amazon Q Business\n web experience to end users.

" + "smithy.api#documentation": "

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

" } }, "com.amazonaws.qbusiness#WebExperienceId": { diff --git a/qconnect/service/2020-10-19/qconnect-2020-10-19.json b/qconnect/service/2020-10-19/qconnect-2020-10-19.json index d129407a..7b27e7ab 100644 --- a/qconnect/service/2020-10-19/qconnect-2020-10-19.json +++ b/qconnect/service/2020-10-19/qconnect-2020-10-19.json @@ -791,6 +791,14 @@ { "value": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "name": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" + }, + { + "value": "MESSAGES", + "name": "MESSAGES" + }, + { + "value": "TEXT_COMPLETIONS", + "name": "TEXT_COMPLETIONS" } ] } @@ -850,7 +858,7 @@ "modelId": { "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n anthropic.claude-3-haiku-20240307-v1:0.

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

The identifier of the model used for this AI Prompt. The following model Ids are\n supported:

\n ", "smithy.api#required": {} } }, @@ -985,7 +993,7 @@ "modelId": { "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n anthropic.claude-3-haiku-20240307-v1:0.

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

The identifier of the model used for this AI Prompt. Model Ids supported are:\n anthropic.claude-3-haiku-20240307-v1:0.

", "smithy.api#required": {} } }, @@ -3378,14 +3386,14 @@ "modelId": { "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n anthropic.claude-3-haiku-20240307-v1:0\n

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

The identifier of the model used for this AI Prompt.

", "smithy.api#required": {} } }, "apiFormat": { "target": "com.amazonaws.qconnect#AIPromptAPIFormat", "traits": { - "smithy.api#documentation": "

The API Format of the AI Prompt.

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

The API Format of the AI Prompt.

\n

Recommended values: MESSAGES | TEXT_COMPLETIONS\n

\n \n

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS\n will be deprecated.

\n ", "smithy.api#required": {} } }, @@ -4917,6 +4925,12 @@ "traits": { "smithy.api#documentation": "

Details about the content data.

" } + }, + "generativeChunkData": { + "target": "com.amazonaws.qconnect#GenerativeChunkDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the generative chunk data.

" + } } }, "traits": { @@ -5589,6 +5603,9 @@ { "target": "com.amazonaws.qconnect#AccessDeniedException" }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, { "target": "com.amazonaws.qconnect#ResourceNotFoundException" }, @@ -6430,6 +6447,32 @@ "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the\n chunkingStrategy as NONE, exclude this field.

" } }, + "com.amazonaws.qconnect#GenerativeChunkDataDetails": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "

A chunk of the LLM response.

" + } + }, + "references": { + "target": "com.amazonaws.qconnect#DataSummaryList", + "traits": { + "smithy.api#documentation": "

The references used to generate the LLM response.

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

The token for the next set of chunks. Use the value returned in the previous response in\n the next request to retrieve the next set of chunks.

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

Details about the generative chunk data.

" + } + }, "com.amazonaws.qconnect#GenerativeContentFeedbackData": { "type": "structure", "members": { @@ -7462,6 +7505,13 @@ "smithy.api#documentation": "

The duration (in seconds) for which the call waits for a recommendation to be made\n available before returning. If a recommendation is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time expires, the\n call returns successfully with an empty list.

", "smithy.api#httpQuery": "waitTimeSeconds" } + }, + "nextChunkToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of chunks. Use the value returned in the previous response in\n the next request to retrieve the next set of chunks.

", + "smithy.api#httpQuery": "nextChunkToken" + } } } }, @@ -10469,6 +10519,20 @@ } } }, + "com.amazonaws.qconnect#MessageConfiguration": { + "type": "structure", + "members": { + "generateFillerMessage": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Generates a filler response when tool selection is QUESTION.

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

The configuration for a SendMessage\n request.

" + } + }, "com.amazonaws.qconnect#MessageData": { "type": "union", "members": { @@ -12124,6 +12188,22 @@ { "value": "GENERATIVE_ANSWER", "name": "GENERATIVE_ANSWER" + }, + { + "value": "GENERATIVE_ANSWER_CHUNK", + "name": "GENERATIVE_ANSWER_CHUNK" + }, + { + "value": "BLOCKED_GENERATIVE_ANSWER_CHUNK", + "name": "BLOCKED_GENERATIVE_ANSWER_CHUNK" + }, + { + "value": "INTENT_ANSWER_CHUNK", + "name": "INTENT_ANSWER_CHUNK" + }, + { + "value": "BLOCKED_INTENT_ANSWER_CHUNK", + "name": "BLOCKED_INTENT_ANSWER_CHUNK" } ] } @@ -13142,6 +13222,22 @@ { "value": "DETECTED_INTENT", "name": "DETECTED_INTENT" + }, + { + "value": "GENERATIVE_ANSWER_CHUNK", + "name": "GENERATIVE_ANSWER_CHUNK" + }, + { + "value": "BLOCKED_GENERATIVE_ANSWER_CHUNK", + "name": "BLOCKED_GENERATIVE_ANSWER_CHUNK" + }, + { + "value": "INTENT_ANSWER_CHUNK", + "name": "INTENT_ANSWER_CHUNK" + }, + { + "value": "BLOCKED_INTENT_ANSWER_CHUNK", + "name": "BLOCKED_INTENT_ANSWER_CHUNK" } ] } @@ -14028,7 +14124,7 @@ } }, "traits": { - "smithy.api#documentation": "

The conversation history data to included in conversation context data before the\n Amazon Q in Connect session.

" + "smithy.api#documentation": "

The conversation history data to included in conversation context data before the Amazon Q\n in Connect session.

" } }, "com.amazonaws.qconnect#SelfServiceConversationHistoryList": { @@ -14160,6 +14256,12 @@ "smithy.api#documentation": "

The conversation context before the Amazon Q in Connect session.

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

The configuration of the SendMessage\n request.

" + } + }, "clientToken": { "target": "com.amazonaws.qconnect#ClientToken", "traits": { @@ -14182,6 +14284,12 @@ "smithy.api#required": {} } }, + "configuration": { + "target": "com.amazonaws.qconnect#MessageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the SendMessage\n request.

" + } + }, "nextMessageToken": { "target": "com.amazonaws.qconnect#NextToken", "traits": { @@ -14320,6 +14428,12 @@ "traits": { "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.

" } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

The origin of the Session to be listed. SYSTEM for a default Session created\n by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.

" + } } }, "traits": { @@ -14909,7 +15023,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 200000 + "max": 1000000 }, "smithy.api#sensitive": {} } diff --git a/quicksight/service/2018-04-01/quicksight-2018-04-01.json b/quicksight/service/2018-04-01/quicksight-2018-04-01.json index 800ab7c3..a2c06262 100644 --- a/quicksight/service/2018-04-01/quicksight-2018-04-01.json +++ b/quicksight/service/2018-04-01/quicksight-2018-04-01.json @@ -3641,6 +3641,12 @@ "traits": { "smithy.api#documentation": "

A list of dataset ARNS to exclude from Dashboard Q&A.

" } + }, + "CustomActionDefaults": { + "target": "com.amazonaws.quicksight#VisualCustomActionDefaults", + "traits": { + "smithy.api#documentation": "

A list of visual custom actions for the analysis.

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

The layout content type of the sheet. Choose one of the following options:

\n " } + }, + "CustomActionDefaults": { + "target": "com.amazonaws.quicksight#VisualCustomActionDefaults", + "traits": { + "smithy.api#documentation": "

A list of visual custom actions for the sheet.

" + } } }, "traits": { @@ -62701,6 +62713,20 @@ "smithy.api#documentation": "

A custom action defined on a visual.

" } }, + "com.amazonaws.quicksight#VisualCustomActionDefaults": { + "type": "structure", + "members": { + "highlightOperation": { + "target": "com.amazonaws.quicksight#VisualHighlightOperation", + "traits": { + "smithy.api#documentation": "

A list of highlight operations available for visuals in an analysis or sheet.

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

A list of custom actions applied to visuals in an analysis or sheet.

" + } + }, "com.amazonaws.quicksight#VisualCustomActionList": { "type": "list", "member": { @@ -62783,6 +62809,44 @@ } } }, + "com.amazonaws.quicksight#VisualHighlightOperation": { + "type": "structure", + "members": { + "Trigger": { + "target": "com.amazonaws.quicksight#VisualHighlightTrigger", + "traits": { + "smithy.api#documentation": "

Specifies whether a highlight operation is initiated by a click or hover, or whether it's disabled.

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

Defines what initiates a highlight operation on a visual, such as a click or hover.

" + } + }, + "com.amazonaws.quicksight#VisualHighlightTrigger": { + "type": "enum", + "members": { + "DATA_POINT_CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_CLICK" + } + }, + "DATA_POINT_HOVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_HOVER" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.quicksight#VisualInteractionOptions": { "type": "structure", "members": { diff --git a/rds/service/2014-10-31/rds-2014-10-31.json b/rds/service/2014-10-31/rds-2014-10-31.json index b9522198..97ff99a6 100644 --- a/rds/service/2014-10-31/rds-2014-10-31.json +++ b/rds/service/2014-10-31/rds-2014-10-31.json @@ -4462,7 +4462,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster

" + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "MonitoringInterval": { @@ -5076,7 +5076,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "LicenseModel": { @@ -5504,7 +5504,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Inherits the value from the source DB instance.

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Inherits the value from the source DB instance.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "Iops": { @@ -6932,6 +6932,9 @@ { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.rds#TenantDatabaseAlreadyExistsFault" }, @@ -6973,9 +6976,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#SensitiveString", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The password for the master user in your tenant database.

\n

Constraints:

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

The password for the master user in your tenant database.

\n

Constraints:

\n " } }, "CharacterSetName": { @@ -6990,6 +6991,18 @@ "smithy.api#documentation": "

The NCHAR value for the tenant database.

" } }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

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

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, "Tags": { "target": "com.amazonaws.rds#TagList" } @@ -7528,7 +7541,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "MonitoringInterval": { @@ -9188,7 +9201,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "ReadReplicaSourceDBInstanceIdentifier": { @@ -21871,7 +21884,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "MonitoringInterval": { @@ -22328,7 +22341,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n

Length Constraints:

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

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBParameterGroupName": { @@ -22376,7 +22389,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.

" + "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "LicenseModel": { @@ -22616,13 +22629,13 @@ "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

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

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } }, "RotateMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

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

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } }, "MasterUserSecretKmsKeyId": { @@ -23801,6 +23814,9 @@ { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.rds#TenantDatabaseAlreadyExistsFault" }, @@ -23842,6 +23858,24 @@ "traits": { "smithy.api#documentation": "

The new name of the tenant database when renaming a tenant database. This parameter\n isn\u2019t case-sensitive.

\n

Constraints:

\n " } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the tenant database doesn't manage the master user password with Amazon Web Services Secrets\n Manager, you can turn on this management. In this case, you can't specify\n MasterUserPassword.

\n

If the tenant database already manages the master user password with Amazon Web Services Secrets\n Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets\n Manager, then you must specify MasterUserPassword. In this case, Amazon RDS\n deletes the secret and uses the new password for the master user specified by\n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

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

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n \n

The Amazon Web Services KMS key identifier is any of the following:

\n \n

To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias\n ARN.

\n

A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" + } } }, "traits": { @@ -28112,7 +28146,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "LicenseModel": { @@ -28309,6 +28343,18 @@ "traits": { "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the\n restored DB instance.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.

\n

Constraints:

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

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } } }, "traits": { @@ -28518,7 +28564,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "LicenseModel": { @@ -28990,7 +29036,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, "LicenseModel": { @@ -29199,6 +29245,18 @@ "traits": { "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.

\n \n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.

\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the\n restored DB instance.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.

\n

Constraints:

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

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } } }, "traits": { @@ -31354,6 +31412,9 @@ "smithy.api#documentation": "

Information about pending changes for a tenant database.

" } }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret" + }, "TagList": { "target": "com.amazonaws.rds#TagList" } @@ -31609,7 +31670,7 @@ "ClientPasswordAuthType": { "target": "com.amazonaws.rds#ClientPasswordAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

\n " } } }, diff --git a/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json b/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json index c02b59ec..c5c61640 100644 --- a/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json +++ b/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json @@ -71,6 +71,18 @@ "target": "com.amazonaws.redshiftserverless#Association" } }, + "com.amazonaws.redshiftserverless#Capacity": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.redshiftserverless#Charge": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.redshiftserverless#ConfigParameter": { "type": "structure", "members": { @@ -142,7 +154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, \n see Working with snapshots and recovery points.

" + "smithy.api#documentation": "

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, \n see Working with snapshots and recovery points.

" } }, "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotRequest": { @@ -497,6 +509,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#CreateReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateReservationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateReservationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#TooManyTagsException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) \n for a year at a discount from Serverless on-demand (OD) rates.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateReservationRequest": { + "type": "structure", + "members": { + "capacity": { + "target": "com.amazonaws.redshiftserverless#Capacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Redshift Processing Units (RPUs) to reserve.

", + "smithy.api#required": {} + } + }, + "offeringId": { + "target": "com.amazonaws.redshiftserverless#OfferingId", + "traits": { + "smithy.api#documentation": "

The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services \n SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see \n Making retries safe with idempotent APIs\n .

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateReservationResponse": { + "type": "structure", + "members": { + "reservation": { + "target": "com.amazonaws.redshiftserverless#Reservation", + "traits": { + "smithy.api#documentation": "

The reservation object that the CreateReservation action created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#CreateScheduledAction": { "type": "operation", "input": { @@ -633,7 +729,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a snapshot of all databases in a namespace.\n For more information about snapshots, see \n \n Working with snapshots and recovery points.

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

Creates a snapshot of all databases in a namespace.\n For more information about snapshots, see \n \n Working with snapshots and recovery points.

", "smithy.api#idempotent": {} } }, @@ -1050,6 +1146,9 @@ } ] }, + "com.amazonaws.redshiftserverless#CurrencyCode": { + "type": "string" + }, "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString": { "type": "string", "traits": { @@ -1598,6 +1697,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#Duration": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.redshiftserverless#Endpoint": { "type": "structure", "members": { @@ -2039,6 +2144,128 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#GetReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetReservationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetReservationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) \n for a year at a discount from Serverless on-demand (OD) rates.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetReservationOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetReservationOfferingRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetReservationOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the reservation offering. The offering determines the payment schedule for the reservation.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetReservationOfferingRequest": { + "type": "structure", + "members": { + "offeringId": { + "target": "com.amazonaws.redshiftserverless#OfferingId", + "traits": { + "smithy.api#documentation": "

The identifier for the offering..

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetReservationOfferingResponse": { + "type": "structure", + "members": { + "reservationOffering": { + "target": "com.amazonaws.redshiftserverless#ReservationOffering", + "traits": { + "smithy.api#documentation": "

The returned reservation offering. The offering determines the payment schedule for the reservation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetReservationRequest": { + "type": "structure", + "members": { + "reservationId": { + "target": "com.amazonaws.redshiftserverless#ReservationId", + "traits": { + "smithy.api#documentation": "

The ID of the reservation to retrieve.

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetReservationResponse": { + "type": "structure", + "members": { + "reservation": { + "target": "com.amazonaws.redshiftserverless#Reservation", + "traits": { + "smithy.api#documentation": "

The returned reservation object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#GetResourcePolicy": { "type": "operation", "input": { @@ -2960,6 +3187,162 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#ListReservationOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListReservationOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListReservationOfferingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current reservation offerings in your account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "reservationOfferingsList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListReservationOfferingsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListReservationOfferingsResponse": { + "type": "structure", + "members": { + "reservationOfferingsList": { + "target": "com.amazonaws.redshiftserverless#ReservationOfferingsList", + "traits": { + "smithy.api#documentation": "

The returned list of reservation offerings.

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

The token to use when requesting the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListReservationsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListReservationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Reservation objects.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "reservationsList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListReservationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListReservationsResponse": { + "type": "structure", + "members": { + "reservationsList": { + "target": "com.amazonaws.redshiftserverless#ReservationsList", + "traits": { + "smithy.api#documentation": "

The serverless reservations returned by the request.

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

The token to use when requesting the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#ListScheduledActions": { "type": "operation", "input": { @@ -3977,6 +4360,30 @@ "target": "smithy.api#Timestamp" } }, + "com.amazonaws.redshiftserverless#OfferingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.redshiftserverless#OfferingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ALL_UPFRONT", + "value": "ALL_UPFRONT" + }, + { + "name": "NO_UPFRONT", + "value": "NO_UPFRONT" + } + ] + } + }, "com.amazonaws.redshiftserverless#OwnerAccount": { "type": "string", "traits": { @@ -4246,6 +4653,9 @@ { "target": "com.amazonaws.redshiftserverless#RecoveryPointResource" }, + { + "target": "com.amazonaws.redshiftserverless#ReservationResource" + }, { "target": "com.amazonaws.redshiftserverless#ScheduledActionResource" }, @@ -5037,6 +5447,156 @@ } } }, + "com.amazonaws.redshiftserverless#Reservation": { + "type": "structure", + "members": { + "reservationId": { + "target": "com.amazonaws.redshiftserverless#ReservationId", + "traits": { + "smithy.api#documentation": "

The identifier that uniquely identifies the serverless reservation.

" + } + }, + "reservationArn": { + "target": "com.amazonaws.redshiftserverless#ReservationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.

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

The start date for the serverless reservation. This is the date you specified for the reservation to start when\n you created the reservation.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "endDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date for the serverless reservation. This date is one year after the start date that you specify.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "capacity": { + "target": "com.amazonaws.redshiftserverless#Capacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Redshift Processing Units (RPUs) to reserve.

" + } + }, + "offering": { + "target": "com.amazonaws.redshiftserverless#ReservationOffering", + "traits": { + "smithy.api#documentation": "

The type of offering for the reservation. The offering class determines the payment schedule for the reservation.

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

The status of the reservation. Possible values include the following:

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

Represents an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) \n for a year at a discount from Serverless on-demand (OD) rates.

" + } + }, + "com.amazonaws.redshiftserverless#ReservationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.redshiftserverless#ReservationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.redshiftserverless#ReservationOffering": { + "type": "structure", + "members": { + "offeringId": { + "target": "com.amazonaws.redshiftserverless#OfferingId", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "duration": { + "target": "com.amazonaws.redshiftserverless#Duration", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration, in seconds, for which the reservation reserves the RPUs.

" + } + }, + "upfrontCharge": { + "target": "com.amazonaws.redshiftserverless#Charge", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The up-front price you are charged for the reservation.

" + } + }, + "hourlyCharge": { + "target": "com.amazonaws.redshiftserverless#Charge", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The rate you are charged for each hour the reservation is active.

" + } + }, + "currencyCode": { + "target": "com.amazonaws.redshiftserverless#CurrencyCode", + "traits": { + "smithy.api#documentation": "

The currency code for the offering.

" + } + }, + "offeringType": { + "target": "com.amazonaws.redshiftserverless#OfferingType", + "traits": { + "smithy.api#documentation": "

Determines the payment schedule for the reservation.

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

The class of offering for the reservation. The offering class determines the payment\n schedule for the reservation.

" + } + }, + "com.amazonaws.redshiftserverless#ReservationOfferingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#ReservationOffering" + } + }, + "com.amazonaws.redshiftserverless#ReservationResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#CreateReservation" + }, + { + "target": "com.amazonaws.redshiftserverless#GetReservation" + }, + { + "target": "com.amazonaws.redshiftserverless#GetReservationOffering" + }, + { + "target": "com.amazonaws.redshiftserverless#ListReservationOfferings" + }, + { + "target": "com.amazonaws.redshiftserverless#ListReservations" + } + ] + }, + "com.amazonaws.redshiftserverless#ReservationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Reservation" + } + }, "com.amazonaws.redshiftserverless#ResourceNotFoundException": { "type": "structure", "members": { @@ -5210,7 +5770,7 @@ "snapshotArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster.\n Must not be specified at the same time as snapshotName.

\n

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring\n from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as\n snapshotName.

\n

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

" } }, "ownerAccount": { @@ -5991,6 +6551,15 @@ ] } }, + "com.amazonaws.redshiftserverless#Status": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.redshiftserverless#SubnetId": { "type": "string" }, diff --git a/resource-explorer-2/service/2022-07-28/resource-explorer-2-2022-07-28.json b/resource-explorer-2/service/2022-07-28/resource-explorer-2-2022-07-28.json index 7a0d2971..d0d1f748 100644 --- a/resource-explorer-2/service/2022-07-28/resource-explorer-2-2022-07-28.json +++ b/resource-explorer-2/service/2022-07-28/resource-explorer-2-2022-07-28.json @@ -952,7 +952,7 @@ "Name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the property that is included in this view.

\n

You can specify the following property names for this field:

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

The name of the property that is included in this view.

\n

You can specify the following property names for this field:

\n ", "smithy.api#length": { "min": 1, "max": 1011 @@ -1400,7 +1400,10 @@ "type": "structure", "members": { "Filters": { - "target": "com.amazonaws.resourceexplorer2#SearchFilter" + "target": "com.amazonaws.resourceexplorer2#SearchFilter", + "traits": { + "smithy.api#documentation": "

An array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a Search \n operation, the filter string is combined with the search's QueryString \n parameter using a logical AND operator.

\n

For information about the supported syntax, see Search query reference for\n Resource Explorer in the Amazon Web Services Resource Explorer User Guide.

\n \n

This query string in the context of this operation supports only filter\n prefixes with optional operators. It doesn't support free-form text. For example, the \n string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters us and is\n not tagged with a key Stage that has the value\n prod.

\n " + } }, "MaxResults": { "target": "smithy.api#Integer", @@ -1425,7 +1428,7 @@ "NextToken": { "target": "smithy.api#String", "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 of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

", + "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 of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

\n \n

The ListResources operation \n does not generate a NextToken if you set MaxResults to 1000.

\n ", "smithy.api#length": { "min": 1, "max": 2048 diff --git a/resource-groups/service/2017-11-27/resource-groups-2017-11-27.json b/resource-groups/service/2017-11-27/resource-groups-2017-11-27.json index b61f0391..d5885db6 100644 --- a/resource-groups/service/2017-11-27/resource-groups-2017-11-27.json +++ b/resource-groups/service/2017-11-27/resource-groups-2017-11-27.json @@ -1887,6 +1887,9 @@ "smithy.api#documentation": "

The tag value.

" } }, + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery" + }, "RoleArn": { "target": "com.amazonaws.resourcegroups#RoleArn", "traits": { @@ -3010,7 +3013,7 @@ "Filters": { "target": "com.amazonaws.resourcegroups#GroupFilterList", "traits": { - "smithy.api#documentation": "

Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.

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

Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.

\n " } }, "MaxResults": { @@ -3703,7 +3706,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an \n application.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

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

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an \n application. To start a tag-sync task, you need a resource tagging role. \n The resource tagging role grants permissions to tag and untag applications resources and must include a \n trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf.

\n

For instructions on creating a tag-sync task, see Create a tag-sync \n using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n ", "smithy.api#http": { "method": "POST", "uri": "/start-tag-sync-task", @@ -3724,15 +3727,19 @@ "TagKey": { "target": "com.amazonaws.resourcegroups#TagKey", "traits": { - "smithy.api#documentation": "

The tag key. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

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

The tag key. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

\n

When using the TagKey parameter, you must also specify the TagValue parameter. If you specify a tag key-value pair, \n you can't use the ResourceQuery parameter.

" } }, "TagValue": { "target": "com.amazonaws.resourcegroups#TagValue", "traits": { - "smithy.api#documentation": "

The tag value. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag value. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

\n

When using the TagValue parameter, you must also specify the TagKey parameter. If you specify a tag key-value pair, \n you can't use the ResourceQuery parameter.

" + } + }, + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery", + "traits": { + "smithy.api#documentation": "

The query you can use to create the tag-sync task. With this method, all resources matching the query \n are added to the specified application group. A\n ResourceQuery specifies both a query Type and a\n Query string as JSON string objects. For more information on defining a resource query for a \n tag-sync task, see the tag-based query type in \n Types of resource group queries in Resource Groups User Guide.

\n

When using the ResourceQuery parameter, you cannot use the TagKey and TagValue parameters.

\n

When you combine all of the elements together into a single string, any double quotes\n that are embedded inside another double quote pair must be escaped by preceding the\n embedded double quote with a backslash character (\\). For example, a complete\n ResourceQuery parameter must be formatted like the following CLI\n parameter example:

\n

\n --resource-query\n '{\"Type\":\"TAG_FILTERS_1_0\",\"Query\":\"{\\\"ResourceTypeFilters\\\":[\\\"AWS::AllSupported\\\"],\\\"TagFilters\\\":[{\\\"Key\\\":\\\"Stage\\\",\\\"Values\\\":[\\\"Test\\\"]}]}\"}'\n

\n

In the preceding example, all of the double quote characters in the value part of the\n Query element must be escaped because the value itself is surrounded by\n double quotes. For more information, see Quoting\n strings in the Command Line Interface User Guide.

\n

For the complete list of resource types that you can use in the array value for\n ResourceTypeFilters, see Resources\n you can use with Resource Groups and Tag Editor in the\n Resource Groups User Guide. For example:

\n

\n \"ResourceTypeFilters\":[\"AWS::S3::Bucket\", \"AWS::EC2::Instance\"]\n

" } }, "RoleArn": { @@ -3780,6 +3787,9 @@ "smithy.api#documentation": "

The tag value of the tag-sync task.

" } }, + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery" + }, "RoleArn": { "target": "com.amazonaws.resourcegroups#RoleArn", "traits": { @@ -3930,6 +3940,9 @@ "smithy.api#documentation": "

The tag value.

" } }, + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery" + }, "RoleArn": { "target": "com.amazonaws.resourcegroups#RoleArn", "traits": { diff --git a/route-53/service/2013-04-01/route-53-2013-04-01.json b/route-53/service/2013-04-01/route-53-2013-04-01.json index ebe8ab4e..7f708966 100644 --- a/route-53/service/2013-04-01/route-53-2013-04-01.json +++ b/route-53/service/2013-04-01/route-53-2013-04-01.json @@ -10920,6 +10920,18 @@ "traits": { "smithy.api#enumValue": "ap-southeast-7" } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } } }, "traits": { diff --git a/s3-control/service/2018-08-20/s3-control-2018-08-20.json b/s3-control/service/2018-08-20/s3-control-2018-08-20.json index b1f28aa4..3edcd46a 100644 --- a/s3-control/service/2018-08-20/s3-control-2018-08-20.json +++ b/s3-control/service/2018-08-20/s3-control-2018-08-20.json @@ -87,6 +87,9 @@ { "target": "com.amazonaws.s3control#DeleteAccessPointPolicyForObjectLambda" }, + { + "target": "com.amazonaws.s3control#DeleteAccessPointScope" + }, { "target": "com.amazonaws.s3control#DeleteBucket" }, @@ -165,6 +168,9 @@ { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambda" }, + { + "target": "com.amazonaws.s3control#GetAccessPointScope" + }, { "target": "com.amazonaws.s3control#GetBucket" }, @@ -225,6 +231,9 @@ { "target": "com.amazonaws.s3control#ListAccessPoints" }, + { + "target": "com.amazonaws.s3control#ListAccessPointsForDirectoryBuckets" + }, { "target": "com.amazonaws.s3control#ListAccessPointsForObjectLambda" }, @@ -261,6 +270,9 @@ { "target": "com.amazonaws.s3control#PutAccessPointPolicyForObjectLambda" }, + { + "target": "com.amazonaws.s3control#PutAccessPointScope" + }, { "target": "com.amazonaws.s3control#PutBucketLifecycleConfiguration" }, @@ -396,6 +408,11 @@ "required": false, "documentation": "When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.", "type": "Boolean" + }, + "UseS3ExpressControlEndpoint": { + "required": false, + "documentation": "Internal parameter to indicate whether S3Express operation should use control plane, (ex. ListDirectoryAccessPoints)", + "type": "Boolean" } }, "rules": [ @@ -414,99 +431,41 @@ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" + "ref": "UseFIPS" }, - "snow" + true ] }, { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { - "ref": "Endpoint" + "ref": "Region" } - ] + ], + "assign": "partitionResult" }, { - "fn": "parseURL", + "fn": "stringEquals", "argv": [ { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", + "fn": "getAttr", "argv": [ { - "ref": "Region" - } - ], - "assign": "partitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "S3 Snow does not support DualStack", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "S3 Snow does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "{url#scheme}://{url#authority}", - "properties": { - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3", - "signingRegion": "{Region}" - } - ] + "ref": "partitionResult" }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "name" + ] + }, + "aws-cn" + ] } ], - "type": "tree" + "error": "Partition does not support FIPS", + "type": "error" }, { "conditions": [ @@ -533,36 +492,6 @@ } ], "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "partitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "error": "Partition does not support FIPS", - "type": "error" - }, { "conditions": [ { @@ -855,59 +784,175 @@ ] }, { - "fn": "aws.parseArn", + "fn": "substring", "argv": [ { "ref": "AccessPointName" - } + }, + 0, + 7, + true ], - "assign": "accessPointArn" + "assign": "accessPointSuffix" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "accessPointSuffix" + }, + "--xa-s3" + ] } ], "rules": [ { "conditions": [ { - "fn": "getAttr", + "fn": "aws.partition", "argv": [ { - "ref": "accessPointArn" - }, - "resourceId[0]" + "ref": "Region" + } ], - "assign": "arnType" - }, + "assign": "partitionResult" + } + ], + "rules": [ { - "fn": "not", - "argv": [ + "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ { - "ref": "arnType" + "ref": "UseDualStack" }, - "" + true ] } - ] - } - ], - "rules": [ + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, { "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 7, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, { "fn": "stringEquals", "argv": [ { - "fn": "getAttr", + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "accessPointArn" + "ref": "UseFIPS" }, - "service" + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } ] }, - "s3-outposts" + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 7, + 16, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 16, + 18, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" ] } ], @@ -915,18 +960,587 @@ { "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "accessPointArn" + "ref": "UseFIPS" }, - "resourceId[1]" - ], - "assign": "outpostId" + true + ] } ], - "rules": [ - { + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 7, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 7, + 21, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 21, + 23, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 7, + 27, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "AccessPointName" + }, + 27, + 29, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express Access Point name format.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseS3ExpressControlEndpoint" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "snow" + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3 Snow does not support DualStack", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "S3 Snow does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccessPointName" + } + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "AccessPointName" + } + ], + "assign": "accessPointArn" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "accessPointArn" + }, + "resourceId[0]" + ], + "assign": "arnType" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "accessPointArn" + }, + "service" + ] + }, + "s3-outposts" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "accessPointArn" + }, + "resourceId[1]" + ], + "assign": "outpostId" + } + ], + "rules": [ + { "conditions": [ { "fn": "isValidHostLabel", @@ -2120,36 +2734,6 @@ } ], "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "partitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "error": "Partition does not support FIPS", - "type": "error" - }, { "conditions": [ { @@ -2723,19 +3307,131 @@ "type": "tree" } ], - "type": "tree" + "type": "tree" + }, + { + "conditions": [], + "error": "Region must be set", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "Vanilla outposts without ARN region + access point ARN@us-west-2", + "expect": { + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts.us-west-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Vanilla outposts with ARN region + access point ARN@us-west-2", + "expect": { + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } }, { - "conditions": [], - "error": "Region must be set", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "Vanilla outposts without ARN region + access point ARN@us-west-2", + "documentation": "accept an access point ARN@us-west-2", "expect": { "endpoint": { "headers": { @@ -2791,7 +3487,7 @@ } }, { - "documentation": "Vanilla outposts with ARN region + access point ARN@us-west-2", + "documentation": "vanilla outposts china@cn-north-1", "expect": { "endpoint": { "headers": { @@ -2807,12 +3503,68 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-1.amazonaws.com" + "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "cn-north-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "gov region@us-west-2", + "expect": { + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ @@ -2822,7 +3574,7 @@ }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, @@ -2832,13 +3584,13 @@ }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, @@ -2847,7 +3599,7 @@ } }, { - "documentation": "accept an access point ARN@us-west-2", + "documentation": "gov cloud with fips@us-west-2", "expect": { "endpoint": { "headers": { @@ -2868,13 +3620,14 @@ } ] }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" + "url": "https://s3-outposts-fips.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { @@ -2884,26 +3637,179 @@ }, { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "govcloud with fips + arn region@us-gov-west-1", + "expect": { + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-gov-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-gov-west-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "gov region@cn-north-1", + "expect": { + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + } + ], + "params": { + "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "cn-north-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "gov cloud with fips@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-west-2", + "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "vanilla outposts china@cn-north-1", + "documentation": "govcloud with fips + arn region@us-gov-west-1", "expect": { "endpoint": { "headers": { @@ -2919,47 +3825,49 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "cn-north-1", + "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" + "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "cn-north-1", + "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "gov region@us-west-2", + "documentation": "gov region@af-south-1", "expect": { "endpoint": { "headers": { @@ -2975,47 +3883,47 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" + "url": "https://s3-outposts.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "af-south-1" }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "af-south-1" }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-west-2", + "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "gov cloud with fips@us-west-2", + "documentation": "gov cloud with fips@af-south-1", "expect": { "endpoint": { "headers": { @@ -3031,42 +3939,42 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-west-2.amazonaws.com" + "url": "https://s3-outposts-fips.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", + "AWS::Region": "af-south-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { - "AWS::Region": "us-west-2", + "AWS::Region": "af-south-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-west-2", + "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true @@ -3131,121 +4039,233 @@ } }, { - "documentation": "gov region@cn-north-1", + "documentation": "CreateBucket + OutpostId = outposts endpoint@us-east-2", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-2", + "disableDoubleEncoding": true + } ] }, + "url": "https://s3-outposts.us-east-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-2" + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "blah", + "OutpostId": "123" + } + } + ], + "params": { + "Bucket": "blah", + "OutpostId": "123", + "Region": "us-east-2", + "RequiresAccountId": false, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "CreateBucket + OutpostId with fips = outposts endpoint@us-east-2", + "expect": { + "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "cn-north-1", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" + "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "us-east-2", + "AWS::UseFIPS": true }, - "operationName": "GetAccessPoint", + "operationName": "CreateBucket", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Bucket": "blah", + "OutpostId": "123" } - }, + } + ], + "params": { + "Bucket": "blah", + "OutpostId": "123", + "Region": "us-east-2", + "RequiresAccountId": false, + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "CreateBucket without OutpostId = regular endpoint@us-east-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-control.us-east-2.amazonaws.com" + } + }, + "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "us-east-2" }, - "operationName": "DeleteAccessPoint", + "operationName": "CreateBucket", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Bucket": "blah" } } ], "params": { - "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "cn-north-1", - "RequiresAccountId": true, + "Bucket": "blah", + "Region": "us-east-2", + "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "gov cloud with fips@cn-north-1", + "documentation": "ListRegionalBuckets + OutpostId = outposts endpoint@us-east-2", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-2", + "disableDoubleEncoding": true + } ] }, + "url": "https://s3-outposts.us-east-2.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-2" + }, + "operationName": "ListRegionalBuckets", + "operationParams": { + "AccountId": "123456789012", + "OutpostId": "op-123" + } + } + ], + "params": { + "AccountId": "123456789012", + "OutpostId": "op-123", + "Region": "us-east-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "ListRegionalBuckets without OutpostId = regular endpoint@us-east-2", + "expect": { + "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "cn-north-1", + "signingName": "s3", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.cn-north-1.amazonaws.com.cn" + "url": "https://123456789012.s3-control.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::UseFIPS": true + "AWS::Region": "us-east-2" }, - "operationName": "GetAccessPoint", + "operationName": "ListRegionalBuckets", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } - }, + } + ], + "params": { + "AccountId": "123456789012", + "Region": "us-east-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "ListRegionalBucket + OutpostId with fips = outposts endpoint@us-east-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" + } + }, + "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", + "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, - "operationName": "DeleteAccessPoint", + "operationName": "ListRegionalBuckets", "operationParams": { - "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "AccountId": "123456789012", + "OutpostId": "op-123" } } ], "params": { - "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "cn-north-1", + "OutpostId": "op-123", + "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "govcloud with fips + arn region@us-gov-west-1", + "documentation": "outpost access points support dualstack@us-west-2", "expect": { "endpoint": { "headers": { @@ -3261,49 +4281,49 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-gov-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" + "url": "https://s3-outposts.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-gov-west-1", + "Region": "us-west-2", "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "gov region@af-south-1", + "documentation": "outpost access points support dualstack@af-south-1", "expect": { "endpoint": { "headers": { @@ -3324,13 +4344,14 @@ } ] }, - "url": "https://s3-outposts.af-south-1.amazonaws.com" + "url": "https://s3-outposts.af-south-1.api.aws" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1" + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { @@ -3340,7 +4361,8 @@ }, { "builtInParams": { - "AWS::Region": "af-south-1" + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { @@ -3354,12 +4376,12 @@ "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, - "UseDualStack": false, + "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "gov cloud with fips@af-south-1", + "documentation": "outpost access points support fips + dualstack@af-south-1", "expect": { "endpoint": { "headers": { @@ -3380,14 +4402,15 @@ } ] }, - "url": "https://s3-outposts-fips.af-south-1.amazonaws.com" + "url": "https://s3-outposts-fips.af-south-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseFIPS": true + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { @@ -3398,7 +4421,8 @@ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseFIPS": true + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { @@ -3412,12 +4436,78 @@ "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, - "UseDualStack": false, + "UseDualStack": true, "UseFIPS": true } }, { - "documentation": "govcloud with fips + arn region@us-gov-west-1", + "documentation": "invalid ARN: must be include outpost ID@us-west-2", + "expect": { + "error": "Invalid ARN: The Outpost Id was not set" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "invalid ARN: must specify access point@us-west-2", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "invalid ARN@us-west-2", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:myaccesspoint", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "when set, AccountId drives AP construction@us-west-2", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myid-1234.s3-control.us-west-2.amazonaws.com" + } + }, + "params": { + "AccessPointName": "myaccesspoint", + "AccountId": "myid-1234", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Account ID set inline and in ARN but they both match@us-west-2", "expect": { "endpoint": { "headers": { @@ -3433,228 +4523,289 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-gov-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" + "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": false }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "AccountId": "123456789012", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" } - }, + } + ], + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseArnRegion": false, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Account ID set inline and in ARN and they do not match@us-west-2", + "expect": { + "error": "Invalid ARN: the accountId specified in the ARN (`123456789012`) does not match the parameter (`999999999999`)" + }, + "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": false }, - "operationName": "DeleteAccessPoint", + "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "AccountId": "999999999999", + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" } } ], "params": { - "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "us-gov-west-1", + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "999999999999", + "Region": "us-west-2", "RequiresAccountId": true, + "UseArnRegion": false, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "CreateBucket + OutpostId = outposts endpoint@us-east-2", + "documentation": "get access point prefixed with account id using endpoint url@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-2.amazonaws.com" + "url": "https://123456789012.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2" + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, - "operationName": "CreateBucket", + "operationName": "GetAccessPoint", "operationParams": { - "Bucket": "blah", - "OutpostId": "123" + "AccountId": "123456789012", + "Name": "apname" } } ], "params": { - "Bucket": "blah", - "OutpostId": "123", - "Region": "us-east-2", - "RequiresAccountId": false, + "AccessPointName": "apname", + "AccountId": "123456789012", + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "CreateBucket + OutpostId with fips = outposts endpoint@us-east-2", + "documentation": "endpoint url with s3-outposts@us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" + "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com" }, - "operationName": "CreateBucket", + "operationName": "GetAccessPoint", "operationParams": { - "Bucket": "blah", - "OutpostId": "123" + "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" } } ], "params": { - "Bucket": "blah", - "OutpostId": "123", - "Region": "us-east-2", - "RequiresAccountId": false, + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Endpoint": "https://beta.example.com", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point name with a bucket arn@us-west-2", + "expect": { + "error": "Expected an outpost type `accesspoint`, found `bucket`" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Endpoint": "beta.example.com", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "bucket arn with access point name@us-west-2", + "expect": { + "error": "Invalid ARN: Expected an outpost type `bucket`, found `accesspoint`" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Endpoint": "beta.example.com", + "Region": "us-west-2", + "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "CreateBucket without OutpostId = regular endpoint@us-east-2", + "documentation": "create bucket with outposts@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-2", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-control.us-east-2.amazonaws.com" + "url": "https://beta.example.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2" - }, - "operationName": "CreateBucket", - "operationParams": { - "Bucket": "blah" - } - } - ], "params": { - "Bucket": "blah", - "Region": "us-east-2", + "Bucket": "bucketname", + "Endpoint": "https://beta.example.com", + "OutpostId": "op-123", + "Region": "us-west-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "ListRegionalBuckets + OutpostId = outposts endpoint@us-east-2", + "documentation": "get bucket with endpoint_url@us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-2.amazonaws.com" + "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2" + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "OutpostId": "op-123" + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "OutpostId": "op-123", - "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Endpoint": "https://beta.example.com", + "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "ListRegionalBuckets without OutpostId = regular endpoint@us-east-2", + "documentation": "ListRegionalBucket + OutpostId endpoint url@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", + "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.s3-control.us-east-2.amazonaws.com" + "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2" + "AWS::Region": "us-east-2", + "SDK::Endpoint": "https://beta.example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { - "AccountId": "123456789012" + "AccountId": "123456789012", + "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", + "Endpoint": "https://beta.example.com", + "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, @@ -3662,7 +4813,7 @@ } }, { - "documentation": "ListRegionalBucket + OutpostId with fips = outposts endpoint@us-east-2", + "documentation": "ListRegionalBucket + OutpostId + fips + endpoint url@us-east-2", "expect": { "endpoint": { "properties": { @@ -3675,14 +4826,15 @@ } ] }, - "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" + "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", - "AWS::UseFIPS": true + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://beta.example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { @@ -3693,6 +4845,7 @@ ], "params": { "AccountId": "123456789012", + "Endpoint": "https://beta.example.com", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, @@ -3701,123 +4854,102 @@ } }, { - "documentation": "outpost access points support dualstack@us-west-2", + "documentation": "ListRegionalBucket + OutpostId + fips + dualstack@us-east-2", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.api.aws" + "url": "https://s3-outposts-fips.us-east-2.api.aws" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true - }, - "operationName": "GetAccessPoint", - "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" - } - }, - { - "builtInParams": { - "AWS::Region": "us-west-2", + "AWS::Region": "us-east-2", + "AWS::UseFIPS": true, "AWS::UseDualStack": true }, - "operationName": "DeleteAccessPoint", + "operationName": "ListRegionalBuckets", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "AccountId": "123456789012", + "OutpostId": "op-123" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-west-2", + "OutpostId": "op-123", + "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": true, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "outpost access points support dualstack@af-south-1", + "documentation": "CreateBucket + OutpostId endpoint url@us-east-2", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "af-south-1", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.af-south-1.api.aws" + "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseDualStack": true - }, - "operationName": "GetAccessPoint", - "operationParams": { - "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" - } - }, - { - "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseDualStack": true + "AWS::Region": "us-east-2", + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://beta.example.com" }, - "operationName": "DeleteAccessPoint", + "operationName": "CreateBucket", "operationParams": { - "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Bucket": "blah", + "OutpostId": "123" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "af-south-1", + "Bucket": "blah", + "Endpoint": "https://beta.example.com", + "OutpostId": "123", + "Region": "us-east-2", + "RequiresAccountId": false, + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "dualstack cannot be used with outposts when an endpoint URL is set@us-west-2.", + "expect": { + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Endpoint": "https://s3-outposts.us-west-2.api.aws", + "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "outpost access points support fips + dualstack@af-south-1", + "documentation": "vanilla bucket arn requires account id@us-west-2", "expect": { "endpoint": { "headers": { @@ -3833,83 +4965,29 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "af-south-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.af-south-1.api.aws" + "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true - }, - "operationName": "GetAccessPoint", - "operationParams": { - "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" - } - }, - { - "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::Region": "us-west-2" }, - "operationName": "DeleteAccessPoint", - "operationParams": { - "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" - } - } - ], - "params": { - "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "af-south-1", - "RequiresAccountId": true, - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "invalid ARN: must be include outpost ID@us-west-2", - "expect": { - "error": "Invalid ARN: The Outpost Id was not set" - }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", - "AccountId": "123456789012", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "invalid ARN: must specify access point@us-west-2", - "expect": { - "error": "Invalid ARN: Expected a 4-component resource" - }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "invalid ARN@us-west-2", - "expect": { - "error": "Invalid ARN: Expected a 4-component resource" - }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Name": "apname", + "AccountId": "123456789012" + } + } + ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:myaccesspoint", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, @@ -3917,25 +4995,44 @@ } }, { - "documentation": "when set, AccountId drives AP construction@us-west-2", + "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myid-1234.s3-control.us-west-2.amazonaws.com" + "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetBucket", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" + } + } + ], "params": { - "AccessPointName": "myaccesspoint", - "AccountId": "myid-1234", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, @@ -3943,7 +5040,7 @@ } }, { - "documentation": "Account ID set inline and in ARN but they both match@us-west-2", + "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", "expect": { "endpoint": { "headers": { @@ -3959,107 +5056,128 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" + "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": false + "AWS::Region": "us-gov-east-1" }, - "operationName": "GetAccessPoint", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "us-west-2", + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-gov-east-1", "RequiresAccountId": true, - "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "Account ID set inline and in ARN and they do not match@us-west-2", + "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", "expect": { - "error": "Invalid ARN: the accountId specified in the ARN (`123456789012`) does not match the parameter (`999999999999`)" + "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-gov-west-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": false + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true }, - "operationName": "GetAccessPoint", + "operationName": "GetBucket", "operationParams": { - "AccountId": "999999999999", - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "999999999999", - "Region": "us-west-2", + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-gov-west-1", "RequiresAccountId": true, - "UseArnRegion": false, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "get access point prefixed with account id using endpoint url@us-west-2", + "documentation": "bucket ARN in aws partition with FIPS@us-east-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", + "signingName": "s3-outposts", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-east-2", + "AWS::UseFIPS": true }, - "operationName": "GetAccessPoint", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "Name": "apname" + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "apname", - "AccountId": "123456789012", - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "us-west-2", + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "endpoint url with s3-outposts@us-west-2", + "documentation": "bucket ARN in aws partition with fips + dualstack@us-east-2", "expect": { "endpoint": { "headers": { @@ -4075,94 +5193,84 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts-fips.us-east-2.api.aws" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-east-2", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, - "operationName": "GetAccessPoint", + "operationName": "GetBucket", "operationParams": { - "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Endpoint": "https://beta.example.com", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "access point name with a bucket arn@us-west-2", - "expect": { - "error": "Expected an outpost type `accesspoint`, found `bucket`" - }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Endpoint": "beta.example.com", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "bucket arn with access point name@us-west-2", - "expect": { - "error": "Invalid ARN: Expected an outpost type `bucket`, found `accesspoint`" - }, - "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Endpoint": "beta.example.com", - "Region": "us-west-2", + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-east-2", "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": true, + "UseFIPS": true } }, { - "documentation": "create bucket with outposts@us-west-2", + "documentation": "vanilla bucket arn requires account id@cn-north-1", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Name": "apname", + "AccountId": "123456789012" + } + } + ], "params": { - "Bucket": "bucketname", - "Endpoint": "https://beta.example.com", - "OutpostId": "op-123", - "Region": "us-west-2", - "RequiresAccountId": false, + "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "cn-north-1", + "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "get bucket with endpoint_url@us-west-2", + "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", "expect": { "endpoint": { "headers": { @@ -4178,30 +5286,28 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-west-2" }, "operationName": "GetBucket", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Endpoint": "https://beta.example.com", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, @@ -4209,90 +5315,108 @@ } }, { - "documentation": "ListRegionalBucket + OutpostId endpoint url@us-east-2", + "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-gov-east-1" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "OutpostId": "op-123" + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "Endpoint": "https://beta.example.com", - "OutpostId": "op-123", - "Region": "us-east-2", + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-gov-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "ListRegionalBucket + OutpostId + fips + endpoint url@us-east-2", + "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingRegion": "us-gov-west-1", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true, - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "OutpostId": "op-123" + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "Endpoint": "https://beta.example.com", - "OutpostId": "op-123", - "Region": "us-east-2", + "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "ListRegionalBucket + OutpostId + fips + dualstack@us-east-2", + "documentation": "bucket ARN in aws partition with FIPS@us-east-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { @@ -4303,81 +5427,70 @@ } ] }, - "url": "https://s3-outposts-fips.us-east-2.api.aws" + "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::UseFIPS": true }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { - "AccountId": "123456789012", - "OutpostId": "op-123" + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "OutpostId": "op-123", + "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-east-2", "RequiresAccountId": true, - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "CreateBucket + OutpostId endpoint url@us-east-2", + "documentation": "Outposts support dualstack @us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://beta.example.com" + "url": "https://s3-outposts.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true, - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true }, - "operationName": "CreateBucket", + "operationName": "GetBucket", "operationParams": { - "Bucket": "blah", - "OutpostId": "123" + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "Bucket": "blah", - "Endpoint": "https://beta.example.com", - "OutpostId": "123", - "Region": "us-east-2", - "RequiresAccountId": false, - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "dualstack cannot be used with outposts when an endpoint URL is set@us-west-2.", - "expect": { - "error": "Invalid Configuration: DualStack and custom endpoint are not supported" - }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Endpoint": "https://s3-outposts.us-west-2.api.aws", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, @@ -4385,7 +5498,7 @@ } }, { - "documentation": "vanilla bucket arn requires account id@us-west-2", + "documentation": "vanilla bucket arn requires account id@af-south-1", "expect": { "endpoint": { "headers": { @@ -4401,30 +5514,30 @@ { "name": "sigv4", "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" + "url": "https://s3-outposts.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "af-south-1" }, "operationName": "CreateAccessPoint", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Name": "apname", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", + "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false @@ -4613,600 +5726,615 @@ } }, { - "documentation": "bucket ARN in aws partition with fips + dualstack@us-east-2", + "documentation": "Invalid ARN: missing outpost id and bucket@us-west-2", + "expect": { + "error": "Invalid ARN: The Outpost Id was not set" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Invalid ARN: missing bucket@us-west-2", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Invalid ARN: missing outpost and bucket ids@us-west-2", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:bucket", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Invalid ARN: missing bucket id@us-west-2", + "expect": { + "error": "Invalid ARN: expected a bucket name" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "account id inserted into hostname@us-west-2", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } ] }, + "url": "https://1234567890.s3-control.us-west-2.amazonaws.com" + } + }, + "params": { + "AccountId": "1234567890", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "account id prefix with dualstack@us-east-1", + "expect": { + "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-east-2.api.aws" + "url": "https://1234567890.s3-control.dualstack.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "params": { + "AccountId": "1234567890", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "account id prefix with fips@us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } + "url": "https://1234567890.s3-control-fips.us-east-1.amazonaws.com" } - ], + }, "params": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-east-2", + "AccountId": "1234567890", + "Region": "us-east-1", "RequiresAccountId": true, - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "vanilla bucket arn requires account id@cn-north-1", + "documentation": "custom account id prefix with fips@us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "cn-north-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" + "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "cn-north-1" - }, - "operationName": "CreateAccessPoint", - "operationParams": { - "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Name": "apname", - "AccountId": "123456789012" - } - } - ], "params": { - "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "cn-north-1", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", + "documentation": "standard url @ us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", + "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-1.amazonaws.com" + "url": "https://s3-control.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2" - }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } - } - ], "params": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { - "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", + "documentation": "fips url @ us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-gov-east-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" + "url": "https://s3-control-fips.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-gov-east-1" - }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } - } - ], "params": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-gov-east-1", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": true } }, { - "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", + "documentation": "dualstack url @ us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-gov-west-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" + "url": "https://s3-control.dualstack.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "params": { + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "fips,dualstack url @ us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } + "url": "https://s3-control-fips.dualstack.us-east-1.amazonaws.com" } - ], + }, "params": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-gov-west-1", - "RequiresAccountId": true, - "UseDualStack": false, + "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": true } }, { - "documentation": "bucket ARN in aws partition with FIPS@us-east-2", + "documentation": "standard url @ cn-north-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingName": "s3", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" + "url": "https://s3-control.cn-north-1.amazonaws.com.cn" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true - }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } - } - ], "params": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-east-2", - "RequiresAccountId": true, - "UseDualStack": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "fips @ cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": true } }, { - "documentation": "Outposts support dualstack @us-west-2", + "documentation": "custom account id prefix @us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.api.aws" + "url": "https://123456789012.s3-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true + "AWS::Region": "us-east-1" }, - "operationName": "GetBucket", + "operationName": "ListRegionalBuckets", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "vanilla bucket arn requires account id@af-south-1", + "documentation": "invalid account id prefix @us-east-1", + "expect": { + "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." + }, + "params": { + "AccountId": "/?invalid¬-host*label", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "custom account id prefix with fips@us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "af-south-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.af-south-1.amazonaws.com" + "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1" + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true }, - "operationName": "CreateAccessPoint", + "operationName": "ListRegionalBuckets", "operationParams": { - "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Name": "apname", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "af-south-1", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", + "documentation": "custom account id prefix with dualstack,fips@us-east-1", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", + "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-1.amazonaws.com" + "url": "https://123456789012.s3-control-fips.dualstack.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, - "operationName": "GetBucket", + "operationName": "ListRegionalBuckets", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": true, + "UseFIPS": true } }, { - "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", + "documentation": "custom account id with custom endpoint", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-gov-east-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" + "url": "https://123456789012.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-east-1" + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://example.com" }, - "operationName": "GetBucket", + "operationName": "ListRegionalBuckets", "operationParams": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-gov-east-1", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Endpoint": "https://example.com" } }, { - "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", + "documentation": "RequiresAccountId with AccountId unset", + "expect": { + "error": "AccountId is required but not set" + }, + "params": { + "Region": "us-east-1", + "RequiresAccountId": true + } + }, + { + "documentation": "RequiresAccountId with AccountId unset and custom endpoint", + "expect": { + "error": "AccountId is required but not set" + }, + "params": { + "Region": "us-east-1", + "Endpoint": "https://beta.example.com", + "RequiresAccountId": true + } + }, + { + "documentation": "RequiresAccountId with invalid AccountId and custom endpoint", + "expect": { + "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." + }, + "params": { + "Region": "us-east-1", + "Endpoint": "https://beta.example.com", + "AccountId": "/?invalid¬-host*label", + "RequiresAccountId": true + } + }, + { + "documentation": "account id with custom endpoint, fips", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-gov-west-1", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" + "url": "https://123456789012.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://example.com" }, - "operationName": "GetBucket", + "operationName": "ListRegionalBuckets", "operationParams": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-gov-west-1", + "AccountId": "123456789012", + "Region": "us-east-1", "RequiresAccountId": true, - "UseDualStack": false, + "Endpoint": "https://example.com", "UseFIPS": true } }, { - "documentation": "bucket ARN in aws partition with FIPS@us-east-2", + "documentation": "custom endpoint, fips", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-2", + "signingName": "s3", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" + "url": "https://example.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2", - "AWS::UseFIPS": true + "params": { + "Region": "us-east-1", + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "custom endpoint, fips", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] }, - "operationName": "GetBucket", - "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" - } + "url": "https://example.com" } - ], + }, "params": { - "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-east-2", - "RequiresAccountId": true, - "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com", "UseFIPS": true } }, { - "documentation": "Invalid ARN: missing outpost id and bucket@us-west-2", + "documentation": "custom endpoint, DualStack", "expect": { - "error": "Invalid ARN: The Outpost Id was not set" + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1", + "Endpoint": "https://example.com", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "Invalid ARN: missing bucket@us-west-2", + "documentation": "region not set", "expect": { - "error": "Invalid ARN: Expected a 4-component resource" + "error": "Region must be set" + } + }, + { + "documentation": "invalid partition", + "expect": { + "error": "Invalid region: region was not a valid DNS name." }, "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", - "Region": "us-west-2", + "Region": "invalid-region 42" + } + }, + { + "documentation": "ListRegionalBuckets + OutpostId without accountId set.", + "expect": { + "error": "AccountId is required but not set" + }, + "params": { + "OutpostId": "op-123", + "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "Invalid ARN: missing outpost and bucket ids@us-west-2", + "documentation": "ListRegionalBuckets + OutpostId with invalid accountId set.", "expect": { - "error": "Invalid ARN: Expected a 4-component resource" + "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." }, "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:bucket", - "Region": "us-west-2", + "AccountId": "/?invalid¬-host*label", + "OutpostId": "op-123", + "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "Invalid ARN: missing bucket id@us-west-2", + "documentation": "accesspoint set but missing accountId", "expect": { - "error": "Invalid ARN: expected a bucket name" + "error": "AccountId is required but not set" }, "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket", + "AccessPointName": "myaccesspoint", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, @@ -5214,24 +6342,12 @@ } }, { - "documentation": "account id inserted into hostname@us-west-2", + "documentation": "outpost accesspoint ARN with missing accountId", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://1234567890.s3-control.us-west-2.amazonaws.com" - } + "error": "Invalid ARN: missing account ID" }, "params": { - "AccountId": "1234567890", + "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:outpost:op1", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, @@ -5239,32 +6355,20 @@ } }, { - "documentation": "account id prefix with dualstack@us-east-1", + "documentation": "bucket ARN with missing accountId", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://1234567890.s3-control.dualstack.us-east-1.amazonaws.com" - } + "error": "Invalid ARN: missing account ID" }, "params": { - "AccountId": "1234567890", - "Region": "us-east-1", + "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-west-2", "RequiresAccountId": true, - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "account id prefix with fips@us-east-1", + "documentation": "endpoint url with accesspoint (non-arn)", "expect": { "endpoint": { "properties": { @@ -5272,423 +6376,543 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://1234567890.s3-control-fips.us-east-1.amazonaws.com" + "url": "https://123456789012.beta.example.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "apname", + "AccountId": "123456789012" + } + } + ], "params": { - "AccountId": "1234567890", - "Region": "us-east-1", + "AccessPointName": "apname", + "Endpoint": "https://beta.example.com", + "AccountId": "123456789012", + "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "custom account id prefix with fips@us-east-1", + "documentation": "access point name with an accesspoint arn@us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" + "url": "https://beta.example.com" } }, "params": { - "AccountId": "123456789012", - "Region": "us-east-1", + "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Endpoint": "https://beta.example.com", + "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "standard url @ us-east-1", + "documentation": "DualStack + Custom endpoint is not supported(non-arn)", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://beta.example.com" }, - "url": "https://s3-control.us-east-1.amazonaws.com" + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "apname", + "AccountId": "123456789012" + } } - }, + ], "params": { - "Region": "us-east-1" + "AccessPointName": "apname", + "Endpoint": "https://beta.example.com", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "fips url @ us-east-1", + "documentation": "get bucket with custom endpoint and dualstack is not supported@us-west-2", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://s3-outposts.us-west-2.api.aws" }, - "url": "https://s3-control-fips.us-east-1.amazonaws.com" + "operationName": "GetBucket", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" + } } - }, + ], "params": { - "Region": "us-east-1", - "UseFIPS": true + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Endpoint": "https://s3-outposts.us-west-2.api.aws", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "dualstack url @ us-east-1", + "documentation": "ListRegionalBuckets + OutpostId with fips in CN.", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] + "error": "Partition does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, - "url": "https://s3-control.dualstack.us-east-1.amazonaws.com" + "operationName": "ListRegionalBuckets", + "operationParams": { + "OutpostId": "op-123", + "AccountId": "012345678912" + } } - }, + ], "params": { - "Region": "us-east-1", - "UseDualStack": true + "AccountId": "012345678912", + "OutpostId": "op-123", + "Region": "cn-north-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "fips,dualstack url @ us-east-1", + "documentation": "ListRegionalBuckets + invalid OutpostId.", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] + "error": "OutpostId must only contain a-z, A-Z, 0-9 and `-`." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-1" }, - "url": "https://s3-control-fips.dualstack.us-east-1.amazonaws.com" + "operationName": "ListRegionalBuckets", + "operationParams": { + "OutpostId": "?outpost/invalid+", + "AccountId": "012345678912" + } } - }, + ], "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "AccountId": "012345678912", + "OutpostId": "?outpost/invalid+", + "Region": "us-west-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "standard url @ cn-north-1", + "documentation": "bucket ARN with mismatched accountId", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://s3-control.cn-north-1.amazonaws.com.cn" - } + "error": "Invalid ARN: the accountId specified in the ARN (`999999`) does not match the parameter (`012345678912`)" }, "params": { - "Region": "cn-north-1" + "Bucket": "arn:aws:s3-outposts:us-west-2:999999:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "012345678912", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "fips @ cn-north-1", + "documentation": "OutpostId with invalid region", "expect": { - "error": "Partition does not support FIPS" + "error": "Invalid region: region was not a valid DNS name." }, "params": { - "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "OutpostId": "op-123", + "Region": "invalid-region 42", + "AccountId": "0123456", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "custom account id prefix @us-east-1", + "documentation": "OutpostId with RequireAccountId unset", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.s3-control.us-east-1.amazonaws.com" + "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, + "params": { + "OutpostId": "op-123", + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Outpost Accesspoint ARN with arn region and client region mismatch with UseArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1" + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": false }, - "operationName": "ListRegionalBuckets", + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": false + }, + "operationName": "DeleteAccessPoint", "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { + "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-east-1", + "Region": "us-west-2", "RequiresAccountId": true, + "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "invalid account id prefix @us-east-1", + "documentation": "Outpost Bucket ARN with arn region and client region mismatch with UseArnRegion=false", "expect": { - "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1" + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com", + "AWS::S3Control::UseArnRegion": false }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { - "AccountId": "/?invalid¬-host*label" + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012" } } ], "params": { - "AccountId": "/?invalid¬-host*label", - "Region": "us-east-1", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Endpoint": "https://beta.example.com", + "Region": "us-west-2", "RequiresAccountId": true, + "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "custom account id prefix with fips@us-east-1", + "documentation": "Accesspoint ARN with region mismatch and UseArnRegion unset", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", + "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" + "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "DeleteAccessPoint", "operationParams": { + "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { + "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", - "Region": "us-east-1", + "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "custom account id prefix with dualstack,fips@us-east-1", + "documentation": "Bucket ARN with region mismatch and UseArnRegion unset", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", + "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.s3-control-fips.dualstack.us-east-1.amazonaws.com" + "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::Region": "us-west-2" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "Region": "us-east-1", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-west-2", "RequiresAccountId": true, - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "custom account id with custom endpoint", + "documentation": "Outpost Bucket ARN with partition mismatch with UseArnRegion=true", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://123456789012.example.com" - } + "error": "Client was configured for partition `aws` but ARN has `aws-cn`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "SDK::Endpoint": "https://example.com" + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": true }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucket", "operationParams": { + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { - "AccountId": "123456789012", - "Region": "us-east-1", + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-west-2", "RequiresAccountId": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "RequiresAccountId with AccountId unset", - "expect": { - "error": "AccountId is required but not set" - }, - "params": { - "Region": "us-east-1", - "RequiresAccountId": true - } - }, - { - "documentation": "RequiresAccountId with AccountId unset and custom endpoint", - "expect": { - "error": "AccountId is required but not set" - }, - "params": { - "Region": "us-east-1", - "Endpoint": "https://beta.example.com", - "RequiresAccountId": true + "UseArnRegion": true, + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "RequiresAccountId with invalid AccountId and custom endpoint", + "documentation": "Accesspoint ARN with partition mismatch and UseArnRegion=true", "expect": { - "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." + "error": "Client was configured for partition `aws` but ARN has `aws-cn`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": true }, - "operationName": "ListRegionalBuckets", + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" + } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3Control::UseArnRegion": true + }, + "operationName": "DeleteAccessPoint", "operationParams": { - "AccountId": "/?invalid¬-host*label" + "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012" } } ], "params": { - "Region": "us-east-1", - "Endpoint": "https://beta.example.com", - "AccountId": "/?invalid¬-host*label", - "RequiresAccountId": true + "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "AccountId": "123456789012", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseArnRegion": true, + "UseFIPS": false } }, { - "documentation": "account id with custom endpoint, fips", + "documentation": "Accesspoint ARN with region mismatch, UseArnRegion=false and custom endpoint", + "expect": { + "error": "Invalid configuration: region from ARN `cn-north-1` does not match client region `us-west-2` and UseArnRegion is `false`" + }, + "params": { + "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Region": "us-west-2", + "Endpoint": "https://example.com", + "RequiresAccountId": true, + "UseDualStack": false, + "UseArnRegion": false, + "UseFIPS": false + } + }, + { + "documentation": "outpost bucket arn@us-west-2", "expect": { "endpoint": { + "headers": { + "x-amz-account-id": [ + "123456789012" + ], + "x-amz-outpost-id": [ + "op-01234567890123456" + ] + }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-east-1", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.example.com" + "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseFIPS": true, - "SDK::Endpoint": "https://example.com" + "AWS::Region": "us-west-2" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetBucketVersioning", "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } + }, + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "PutBucketVersioning", + "operationParams": { + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "123456789012", + "VersioningConfiguration": { + "Status": "Enabled" + } + } } ], "params": { - "AccountId": "123456789012", - "Region": "us-east-1", - "RequiresAccountId": true, - "Endpoint": "https://example.com", - "UseFIPS": true + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Region": "us-west-2", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "custom endpoint, fips", + "documentation": "S3 Snow Control with bucket", "expect": { "endpoint": { "properties": { @@ -5696,22 +6920,24 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-east-1", + "signingRegion": "snow", "disableDoubleEncoding": true } ] }, - "url": "https://example.com" + "url": "https://10.0.1.12:433" } }, "params": { - "Region": "us-east-1", - "Endpoint": "https://example.com", - "UseFIPS": true + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://10.0.1.12:433", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "custom endpoint, fips", + "documentation": "S3 Snow Control without bucket", "expect": { "endpoint": { "properties": { @@ -5719,792 +6945,906 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-east-1", + "signingRegion": "snow", "disableDoubleEncoding": true } ] }, - "url": "https://example.com" + "url": "https://10.0.1.12:433" } }, "params": { - "Region": "us-east-1", - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "custom endpoint, DualStack", - "expect": { - "error": "Invalid Configuration: DualStack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "Endpoint": "https://example.com", + "Region": "snow", + "Endpoint": "https://10.0.1.12:433", "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "region not set", - "expect": { - "error": "Region must be set" - } - }, - { - "documentation": "invalid partition", - "expect": { - "error": "Invalid region: region was not a valid DNS name." - }, - "params": { - "Region": "invalid-region 42" + "UseDualStack": false } }, { - "documentation": "ListRegionalBuckets + OutpostId without accountId set.", + "documentation": "S3 Snow Control with bucket and without port", "expect": { - "error": "AccountId is required but not set" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://10.0.1.12" + } }, "params": { - "OutpostId": "op-123", - "Region": "us-east-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://10.0.1.12", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "ListRegionalBuckets + OutpostId with invalid accountId set.", + "documentation": "S3 Snow Control with bucket and with DNS", "expect": { - "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] }, - "operationName": "ListRegionalBuckets", - "operationParams": { - "OutpostId": "op-123", - "AccountId": "/?invalid¬-host*label" - } + "url": "http://s3snow.com" } - ], - "params": { - "AccountId": "/?invalid¬-host*label", - "OutpostId": "op-123", - "Region": "us-east-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "accesspoint set but missing accountId", - "expect": { - "error": "AccountId is required but not set" }, "params": { - "AccessPointName": "myaccesspoint", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "http://s3snow.com", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "outpost accesspoint ARN with missing accountId", + "documentation": "S3 Snow Control with FIPS enabled", "expect": { - "error": "Invalid ARN: missing account ID" + "error": "S3 Snow does not support FIPS" }, "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:outpost:op1", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://10.0.1.12:433", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "bucket ARN with missing accountId", + "documentation": "S3 Snow Control with Dualstack enabled", "expect": { - "error": "Invalid ARN: missing account ID" + "error": "S3 Snow does not support DualStack" }, "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://10.0.1.12:433", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "endpoint url with accesspoint (non-arn)", + "documentation": "Access Point APIs on express bucket routed to s3express-control", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", + "signingName": "s3express", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://123456789012.beta.example.com" + "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-east-1" + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "apname", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } - } - ], - "params": { - "AccessPointName": "apname", - "Endpoint": "https://beta.example.com", - "AccountId": "123456789012", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "access point name with an accesspoint arn@us-west-2", - "expect": { - "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "https://beta.example.com" - } - }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Endpoint": "https://beta.example.com", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "DualStack + Custom endpoint is not supported(non-arn)", - "expect": { - "error": "Invalid Configuration: DualStack and custom endpoint are not supported" - }, - "operationInputs": [ + "operationName": "PutAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "DeleteAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-east-1" }, - "operationName": "GetAccessPoint", + "operationName": "GetAccessPointPolicy", "operationParams": { - "Name": "apname", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } - } - ], - "params": { - "AccessPointName": "apname", - "Endpoint": "https://beta.example.com", - "AccountId": "123456789012", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "get bucket with custom endpoint and dualstack is not supported@us-west-2", - "expect": { - "error": "Invalid Configuration: DualStack and custom endpoint are not supported" - }, - "operationInputs": [ + }, { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, - "SDK::Endpoint": "https://s3-outposts.us-west-2.api.aws" + "AWS::Region": "us-east-1" }, - "operationName": "GetBucket", + "operationName": "DeleteAccessPointPolicy", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } - } - ], - "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Endpoint": "https://s3-outposts.us-west-2.api.aws", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "ListRegionalBuckets + OutpostId with fips in CN.", - "expect": { - "error": "Partition does not support FIPS" - }, - "operationInputs": [ + }, { "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::UseFIPS": true + "AWS::Region": "us-east-1" }, - "operationName": "ListRegionalBuckets", + "operationName": "GetAccessPointPolicyStatus", "operationParams": { - "OutpostId": "op-123", - "AccountId": "0123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } } ], "params": { - "AccountId": "0123456789012", - "OutpostId": "op-123", - "Region": "cn-north-1", + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "ListRegionalBuckets + invalid OutpostId.", + "documentation": "Access Point APIs on express bucket routed to s3express-control for List", "expect": { - "error": "OutpostId must only contain a-z, A-Z, 0-9 and `-`." + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3express-control.us-east-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-1" + "AWS::Region": "us-east-1" }, - "operationName": "ListRegionalBuckets", + "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { - "OutpostId": "?outpost/invalid+", - "AccountId": "0123456789012" + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" } } ], "params": { - "AccountId": "0123456789012", - "OutpostId": "?outpost/invalid+", - "Region": "us-west-1", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "bucket ARN with mismatched accountId", - "expect": { - "error": "Invalid ARN: the accountId specified in the ARN (`999999`) does not match the parameter (`0123456789012`)" - }, - "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:999999:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "0123456789012", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "OutpostId with invalid region", - "expect": { - "error": "Invalid region: region was not a valid DNS name." - }, - "params": { - "OutpostId": "op-123", - "Region": "invalid-region 42", - "AccountId": "0123456", + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "OutpostId with RequireAccountId unset", + "documentation": "Access Point APIs on express bucket routed to s3express-control for FIPS", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-2", + "signingName": "s3express", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" + "url": "https://s3express-control-fips.us-east-1.amazonaws.com" } }, - "params": { - "OutpostId": "op-123", - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "Outpost Accesspoint ARN with arn region and client region mismatch with UseArnRegion=false", - "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" - }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": false + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } }, { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": false + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "PutAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "us-west-2", + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Region": "us-east-1", "RequiresAccountId": true, - "UseArnRegion": false, "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "Outpost Bucket ARN with arn region and client region mismatch with UseArnRegion=false", + "documentation": "Access Point APIs on express bucket routed to s3express-control for FIPS for List", "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3express-control-fips.us-east-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://beta.example.com", - "AWS::S3Control::UseArnRegion": false + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true }, - "operationName": "GetBucket", + "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Endpoint": "https://beta.example.com", - "Region": "us-west-2", + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, - "UseArnRegion": false, "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "Accesspoint ARN with region mismatch and UseArnRegion unset", - "expect": { - "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, + "UseFIPS": true + } + }, + { + "documentation": "Access Point APIs on express bucket routed to s3express-control for china region", + "expect": { + "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "signingName": "s3express", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-1.amazonaws.com" + "url": "https://s3express-control.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "cn-north-1" + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } }, { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "PutAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "DeleteAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "us-west-2", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "Bucket ARN with region mismatch and UseArnRegion unset", + "documentation": "Access Point APIs on express bucket routed to s3express-control for china region for List", "expect": { "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] - }, "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "signingName": "s3express", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-outposts.us-east-1.amazonaws.com" + "url": "https://s3express-control.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "cn-north-1" }, - "operationName": "GetBucket", + "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" } } ], "params": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", + "AccountId": "871317572157", + "Region": "cn-north-1", + "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "Outpost Bucket ARN with partition mismatch with UseArnRegion=true", + "documentation": "Error when Access Point APIs on express bucket routed to s3express-control for china and FIPS", "expect": { - "error": "Client was configured for partition `aws` but ARN has `aws-cn`" + "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": true + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, - "operationName": "GetBucket", + "operationName": "CreateAccessPoint", "operationParams": { - "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } } - } - ], - "params": { - "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseArnRegion": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "Accesspoint ARN with partition mismatch and UseArnRegion=true", - "expect": { - "error": "Client was configured for partition `aws` but ARN has `aws-cn`" - }, - "operationInputs": [ + }, { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": true + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } }, { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3Control::UseArnRegion": true + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { - "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012" + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "PutAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPointScope", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" } } ], "params": { - "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "AccountId": "123456789012", - "Region": "us-west-2", + "AccountId": "871317572157", + "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, - "UseArnRegion": true, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "Accesspoint ARN with region mismatch, UseArnRegion=false and custom endpoint", + "documentation": "Error Access Point APIs on express bucket routed to s3express-control invalid zone", "expect": { - "error": "Invalid configuration: region from ARN `cn-north-1` does not match client region `us-west-2` and UseArnRegion is `false`" + "error": "Unrecognized S3Express Access Point name format." }, - "params": { - "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Region": "us-west-2", - "Endpoint": "https://example.com", - "RequiresAccountId": true, - "UseDualStack": false, - "UseArnRegion": false, - "UseFIPS": false - } - }, - { - "documentation": "outpost bucket arn@us-west-2", - "expect": { - "endpoint": { - "headers": { - "x-amz-account-id": [ - "123456789012" - ], - "x-amz-outpost-id": [ - "op-01234567890123456" - ] + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "Bucket": "mybucket-garbage-zone-garbage-zone", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "https://s3-outposts.us-west-2.amazonaws.com" - } - }, - "operationInputs": [ + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } + }, { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-east-1" }, - "operationName": "GetBucketVersioning", + "operationName": "DeleteAccessPoint", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012" + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" } }, { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-east-1" }, - "operationName": "PutBucketVersioning", + "operationName": "PutAccessPointScope", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "123456789012", - "VersioningConfiguration": { - "Status": "Enabled" + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] } } - } - ], - "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Region": "us-west-2", - "RequiresAccountId": true, - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "S3 Snow Control with bucket", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", - "disableDoubleEncoding": true - } - ] + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "https://10.0.1.12:433" - } - }, - "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "https://10.0.1.12:433", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "S3 Snow Control without bucket", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", - "disableDoubleEncoding": true - } - ] + "operationName": "GetAccessPointScope", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "https://10.0.1.12:433" - } - }, - "params": { - "Region": "snow", - "Endpoint": "https://10.0.1.12:433", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "S3 Snow Control with bucket and without port", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", - "disableDoubleEncoding": true - } - ] + "operationName": "DeleteAccessPointScope", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "https://10.0.1.12" - } - }, - "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "https://10.0.1.12", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "S3 Snow Control with bucket and with DNS", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", - "disableDoubleEncoding": true - } - ] + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" }, - "url": "http://s3snow.com" + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157" + } } - }, - "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "http://s3snow.com", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "S3 Snow Control with FIPS enabled", - "expect": { - "error": "S3 Snow does not support FIPS" - }, - "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "https://10.0.1.12:433", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "S3 Snow Control with Dualstack enabled", - "expect": { - "error": "S3 Snow does not support DualStack" - }, + ], "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "https://10.0.1.12:433", - "UseFIPS": false, - "UseDualStack": true + "AccessPointName": "myaccesspoint-garbage-zone--xa-s3", + "AccountId": "871317572157", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false } } ], @@ -7709,7 +9049,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Creates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n \n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

\n ", + "smithy.api#documentation": "

Creates an access point and associates it to a specified bucket. For more information, see\n Managing\n access to shared datasets in general purpose buckets with access points or Managing\n access to shared datasets in directory buckets with access points in the\n Amazon S3 User Guide.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n \n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -7823,9 +9163,12 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

The name you want to assign to this access point.

", + "smithy.api#documentation": "

The name you want to assign to this access point.

\n

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccessPointName" + } } }, "Bucket": { @@ -7855,6 +9198,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

\n

For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. \n For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.\n

" } + }, + "Scope": { + "target": "com.amazonaws.s3control#Scope", + "traits": { + "smithy.api#documentation": "

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

\n \n

Scope is not supported for access points for general purpose buckets.

\n " + } } }, "traits": { @@ -8591,7 +9940,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

\n ", + "smithy.api#documentation": "

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8669,7 +10018,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

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 x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

\n ", + "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 x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -8764,18 +10113,74 @@ } } } - }, - "traits": { - "smithy.api#input": {} + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#DeleteAccessPointRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID for the account that owns the specified access point.

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the access point you want to delete.

\n

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

\n

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::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": {}, + "smithy.rules#contextParam": { + "name": "AccessPointName" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#DeleteAccessPointScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#DeleteAccessPointScopeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes an existing access point scope for a directory bucket.

\n \n

When you delete the scope of an access point, all prefixes and permissions are deleted.

\n \n

To use this operation, you must have the permission to perform the\n s3express:DeleteAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v20180820/accesspoint/{Name}/scope", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + }, + "UseS3ExpressControlEndpoint": { + "value": true + } + } } }, - "com.amazonaws.s3control#DeleteAccessPointRequest": { + "com.amazonaws.s3control#DeleteAccessPointScopeRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID for the account that owns the specified access point.

", + "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with the scope that you want to delete.\n

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -8787,7 +10192,7 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

The name of the access point you want to delete.

\n

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

\n

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::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#documentation": "

\n The name of the access point with the scope that you want to delete.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -10394,7 +11799,7 @@ "target": "com.amazonaws.s3control#GetAccessPointResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

\n ", + "smithy.api#documentation": "

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10571,7 +11976,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Returns the access point policy associated with the specified access point.

\n

The following actions are related to GetAccessPointPolicy:

\n ", + "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}." }, @@ -10929,6 +12334,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.s3control#GetAccessPointScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#GetAccessPointScopeRequest" + }, + "output": { + "target": "com.amazonaws.s3control#GetAccessPointScopeResult" + }, + "traits": { + "smithy.api#documentation": "

\n Returns the access point scope for a directory bucket.

\n

To use this operation, you must have the permission to perform the\n s3express:GetAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v20180820/accesspoint/{Name}/scope", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + }, + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#GetAccessPointScopeRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.\n

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the access point with the scope you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccessPointName" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#GetAccessPointScopeResult": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.s3control#Scope", + "traits": { + "smithy.api#documentation": "

The contents of the access point scope.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3control#GetBucket": { "type": "operation", "input": { @@ -13774,6 +15249,99 @@ } } }, + "com.amazonaws.s3control#ListAccessPointsForDirectoryBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsRequest" + }, + "output": { + "target": "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

\n

To list access points for general purpose buckets, see ListAccesspoints.

\n

To use this operation, you must have the permission to perform the\n s3express:ListAccessPointsForDirectoryBuckets action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v20180820/accesspointfordirectory", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccessPointList", + "pageSize": "MaxResults" + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + }, + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the access points.

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "DirectoryBucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the directory bucket associated with the access points you want to list.

", + "smithy.api#httpQuery": "directoryBucket" + } + }, + "NextToken": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "traits": { + "smithy.api#documentation": "

\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.s3control#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsResult": { + "type": "structure", + "members": { + "AccessPointList": { + "target": "com.amazonaws.s3control#AccessPointList", + "traits": { + "smithy.api#documentation": "

Contains identification and configuration information for one or more access points associated with the directory bucket.

" + } + }, + "NextToken": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "traits": { + "smithy.api#documentation": "

\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3control#ListAccessPointsForObjectLambda": { "type": "operation", "input": { @@ -15673,6 +17241,15 @@ "smithy.api#documentation": "

A container for the prefix-level storage metrics for S3 Storage Lens.

" } }, + "com.amazonaws.s3control#PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#Prefix", + "traits": { + "smithy.api#xmlName": "Prefix" + } + } + }, "com.amazonaws.s3control#Priority": { "type": "integer", "traits": { @@ -15910,7 +17487,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

\n ", + "smithy.api#documentation": "

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

\n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16015,7 +17592,70 @@ "Policy": { "target": "com.amazonaws.s3control#Policy", "traits": { - "smithy.api#documentation": "

The policy that you want to apply to the specified access point. For more information about access point\n policies, see Managing data access with Amazon S3\n access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The policy that you want to apply to the specified access point. For more information about access point\n policies, see Managing access to shared datasets in general purpose buckets with\n access points or Managing access to shared datasets in directory bucekts with access points in the Amazon S3 User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#PutAccessPointScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#PutAccessPointScopeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

\n \n

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

\n \n

To use this operation, you must have the permission to perform the\n s3express:PutAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v20180820/accesspoint/{Name}/scope", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + }, + "UseS3ExpressControlEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#PutAccessPointScopeRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.\n

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the access point with the scope that you want to create or replace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccessPointName" + } + } + }, + "Scope": { + "target": "com.amazonaws.s3control#Scope", + "traits": { + "smithy.api#documentation": "

Object prefixes, API operations, or a combination of both.

", "smithy.api#required": {} } } @@ -18339,6 +19979,90 @@ "smithy.api#xmlName": "SSE-S3" } }, + "com.amazonaws.s3control#Scope": { + "type": "structure", + "members": { + "Prefixes": { + "target": "com.amazonaws.s3control#PrefixesList", + "traits": { + "smithy.api#documentation": "

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

", + "smithy.api#xmlName": "Prefixes" + } + }, + "Permissions": { + "target": "com.amazonaws.s3control#ScopePermissionList", + "traits": { + "smithy.api#documentation": "

You can include one or more API operations as permissions.

", + "smithy.api#xmlName": "Permissions" + } + } + }, + "traits": { + "smithy.api#documentation": "

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

\n

For more information, see Manage the scope of your access points for directory buckets.\n

" + } + }, + "com.amazonaws.s3control#ScopePermission": { + "type": "enum", + "members": { + "GetObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetObject" + } + }, + "GetObjectAttributes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetObjectAttributes" + } + }, + "ListMultipartUploadParts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ListMultipartUploadParts" + } + }, + "ListBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ListBucket" + } + }, + "ListBucketMultipartUploads": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ListBucketMultipartUploads" + } + }, + "PutObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutObject" + } + }, + "DeleteObject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteObject" + } + }, + "AbortMultipartUpload": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AbortMultipartUpload" + } + } + } + }, + "com.amazonaws.s3control#ScopePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#ScopePermission", + "traits": { + "smithy.api#xmlName": "Permission" + } + } + }, "com.amazonaws.s3control#SecretAccessKey": { "type": "string", "traits": { diff --git a/s3/service/2006-03-01/s3-2006-03-01.json b/s3/service/2006-03-01/s3-2006-03-01.json index 676e569a..32e72a3b 100644 --- a/s3/service/2006-03-01/s3-2006-03-01.json +++ b/s3/service/2006-03-01/s3-2006-03-01.json @@ -100,7 +100,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -1171,25 +1171,1273 @@ { "conditions": [ { - "fn": "uriEncode", + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}/{uri_encoded_bucket}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 19, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 19, + 21, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 26, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 26, + 28, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 14, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 14, + 16, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 19, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 19, + 21, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 6, + 26, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 26, + 28, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Bucket" + } + ] + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 0, + 7, + true + ], + "assign": "accessPointSuffix" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "accessPointSuffix" + }, + "--xa-s3" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "Accelerate" + }, + true + ] + } + ], + "error": "S3Express does not support S3 Accelerate.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", "argv": [ { - "ref": "Bucket" + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "url" + }, + "isIp" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "uriEncode", + "argv": [ + { + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" } ], - "assign": "uri_encoded_bucket" + "type": "tree" }, { - "fn": "not", + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "fn": "isSet", + "fn": "getAttr", "argv": [ { - "ref": "Endpoint" - } + "ref": "url" + }, + "isIp" ] - } + }, + true ] } ], @@ -1197,42 +2445,64 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "uriEncode", "argv": [ { - "ref": "UseFIPS" + "ref": "Bucket" + } + ], + "assign": "uri_encoded_bucket" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "{url#scheme}://{url#authority}/{uri_encoded_bucket}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] }, - true - ] + "headers": {} + }, + "type": "endpoint" } ], - "endpoint": { - "url": "https://s3express-control-fips.{Region}.amazonaws.com/{uri_encoded_bucket}", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "aws.isVirtualHostableS3Bucket", + "argv": [ + { + "ref": "Bucket" }, - "headers": {} - }, - "type": "endpoint" - }, + false + ] + } + ], + "rules": [ { "conditions": [], "endpoint": { - "url": "https://s3express-control.{Region}.amazonaws.com/{uri_encoded_bucket}", + "url": "{url#scheme}://{Bucket}.{url#authority}{url#path}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1244,6 +2514,11 @@ } ], "type": "tree" + }, + { + "conditions": [], + "error": "S3Express bucket name is not a valid virtual hostable name.", + "type": "error" } ], "type": "tree" @@ -1264,24 +2539,485 @@ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { - "ref": "DisableS3ExpressSessionAuth" + "ref": "Region" } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "DisableS3ExpressSessionAuth" - }, - true - ] + ], + "assign": "partitionResult" } ], "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "DisableS3ExpressSessionAuth" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 7, + 15, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 15, + 17, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 7, + 16, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 16, + 18, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 7, + 20, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 20, + 22, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 7, + 21, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 21, + 23, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 7, + 27, + true + ], + "assign": "s3expressAvailabilityZoneId" + }, + { + "fn": "substring", + "argv": [ + { + "ref": "Bucket" + }, + 27, + 29, + true + ], + "assign": "s3expressAvailabilityZoneDelim" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "s3expressAvailabilityZoneDelim" + }, + "--" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Unrecognized S3Express bucket name format.", + "type": "error" + } + ], + "type": "tree" + }, { "conditions": [ { @@ -1290,8 +3026,8 @@ { "ref": "Bucket" }, - 6, - 14, + 7, + 15, true ], "assign": "s3expressAvailabilityZoneId" @@ -1302,8 +3038,8 @@ { "ref": "Bucket" }, - 14, - 16, + 15, + 17, true ], "assign": "s3expressAvailabilityZoneDelim" @@ -1332,13 +3068,13 @@ } ], "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1351,13 +3087,13 @@ { "conditions": [], "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1378,8 +3114,8 @@ { "ref": "Bucket" }, - 6, - 15, + 7, + 16, true ], "assign": "s3expressAvailabilityZoneId" @@ -1390,8 +3126,8 @@ { "ref": "Bucket" }, - 15, - 17, + 16, + 18, true ], "assign": "s3expressAvailabilityZoneDelim" @@ -1420,13 +3156,13 @@ } ], "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1439,13 +3175,13 @@ { "conditions": [], "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1466,8 +3202,8 @@ { "ref": "Bucket" }, - 6, - 19, + 7, + 20, true ], "assign": "s3expressAvailabilityZoneId" @@ -1478,8 +3214,8 @@ { "ref": "Bucket" }, - 19, - 21, + 20, + 22, true ], "assign": "s3expressAvailabilityZoneDelim" @@ -1508,13 +3244,13 @@ } ], "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1527,13 +3263,13 @@ { "conditions": [], "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1554,8 +3290,8 @@ { "ref": "Bucket" }, - 6, - 20, + 7, + 21, true ], "assign": "s3expressAvailabilityZoneId" @@ -1566,8 +3302,8 @@ { "ref": "Bucket" }, - 20, - 22, + 21, + 23, true ], "assign": "s3expressAvailabilityZoneDelim" @@ -1596,13 +3332,13 @@ } ], "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1615,13 +3351,13 @@ { "conditions": [], "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1642,8 +3378,8 @@ { "ref": "Bucket" }, - 6, - 26, + 7, + 27, true ], "assign": "s3expressAvailabilityZoneId" @@ -1654,8 +3390,8 @@ { "ref": "Bucket" }, - 26, - 28, + 27, + 29, true ], "assign": "s3expressAvailabilityZoneDelim" @@ -1684,13 +3420,13 @@ } ], "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1703,13 +3439,13 @@ { "conditions": [], "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", + "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.{partitionResult#dnsSuffix}", "properties": { "backend": "S3Express", "authSchemes": [ { "disableDoubleEncoding": true, - "name": "sigv4", + "name": "sigv4-s3express", "signingName": "s3express", "signingRegion": "{Region}" } @@ -1729,451 +3465,6 @@ } ], "type": "tree" - }, - { - "conditions": [ - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 6, - 14, - true - ], - "assign": "s3expressAvailabilityZoneId" - }, - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 14, - 16, - true - ], - "assign": "s3expressAvailabilityZoneDelim" - }, - { - "fn": "stringEquals", - "argv": [ - { - "ref": "s3expressAvailabilityZoneDelim" - }, - "--" - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 6, - 15, - true - ], - "assign": "s3expressAvailabilityZoneId" - }, - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 15, - 17, - true - ], - "assign": "s3expressAvailabilityZoneDelim" - }, - { - "fn": "stringEquals", - "argv": [ - { - "ref": "s3expressAvailabilityZoneDelim" - }, - "--" - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 6, - 19, - true - ], - "assign": "s3expressAvailabilityZoneId" - }, - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 19, - 21, - true - ], - "assign": "s3expressAvailabilityZoneDelim" - }, - { - "fn": "stringEquals", - "argv": [ - { - "ref": "s3expressAvailabilityZoneDelim" - }, - "--" - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 6, - 20, - true - ], - "assign": "s3expressAvailabilityZoneId" - }, - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 20, - 22, - true - ], - "assign": "s3expressAvailabilityZoneDelim" - }, - { - "fn": "stringEquals", - "argv": [ - { - "ref": "s3expressAvailabilityZoneDelim" - }, - "--" - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 6, - 26, - true - ], - "assign": "s3expressAvailabilityZoneId" - }, - { - "fn": "substring", - "argv": [ - { - "ref": "Bucket" - }, - 26, - 28, - true - ], - "assign": "s3expressAvailabilityZoneDelim" - }, - { - "fn": "stringEquals", - "argv": [ - { - "ref": "s3expressAvailabilityZoneDelim" - }, - "--" - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "endpoint": { - "url": "https://{Bucket}.s3express-fips-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://{Bucket}.s3express-{s3expressAvailabilityZoneId}.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4-s3express", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Unrecognized S3Express bucket name format.", - "type": "error" } ], "type": "tree" @@ -2223,87 +3514,103 @@ { "conditions": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", + "fn": "aws.partition", "argv": [ { - "ref": "Endpoint" + "ref": "Region" } ], - "assign": "url" + "assign": "partitionResult" } ], - "endpoint": { - "url": "{url#scheme}://{url#authority}{url#path}", - "properties": { - "backend": "S3Express", - "authSchemes": [ - { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3express", - "signingRegion": "{Region}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + "rules": [ { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] }, - true - ] - } - ], - "endpoint": { - "url": "https://s3express-control-fips.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3express", - "signingRegion": "{Region}" + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" } - ] + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}{url#path}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://s3express-control.{Region}.amazonaws.com", - "properties": { - "backend": "S3Express", - "authSchemes": [ + { + "conditions": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3express", - "signingRegion": "{Region}" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } - ] + ], + "endpoint": { + "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" }, - "headers": {} - }, - "type": "endpoint" + { + "conditions": [], + "endpoint": { + "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "backend": "S3Express", + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" } ], "type": "tree" @@ -12379,16 +13686,533 @@ } }, { - "documentation": "FIPS + dualstack + non-DNS endpoint", + "documentation": "FIPS + dualstack + non-DNS endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "endpoint override + FIPS + dualstack (BUG)", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "endpoint override + non-dns bucket + FIPS (BUG)", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "FIPS + bucket endpoint + force path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "bucket + FIPS + force path style", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "ForcePathStyle": true, + "UseFIPS": true, + "UseDualStack": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + dualstack + use global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bucket.s3-fips.dualstack.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "UseFIPS": true, + "UseDualStack": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "URI encoded bucket + use global endpoint", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "https://foo.com" + } + }, + { + "documentation": "FIPS + path based endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "accelerate + dualstack + global endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bucket.s3-accelerate.dualstack.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "dualstack + global endpoint + non URI safe bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "Accelerate": false, + "UseDualStack": true, + "UseFIPS": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + uri encoded bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "Accelerate": false, + "UseDualStack": false, + "UseFIPS": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "endpoint override + non-uri safe endpoint + force path style", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "ForcePathStyle": true, + "Accelerate": false, + "UseDualStack": false, + "UseFIPS": true, + "Endpoint": "http://foo.com", + "UseGlobalEndpoint": true + } + }, + { + "documentation": "FIPS + Dualstack + global endpoint + non-dns bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true, + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "us-east-1", + "Bucket": "bucket!", + "Accelerate": false, + "UseDualStack": true, + "UseFIPS": true, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "endpoint override + FIPS + dualstack", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": true, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "non-bucket endpoint override + dualstack + global endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "Endpoint override + UseGlobalEndpoint + us-east-1", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "non-FIPS partition with FIPS set + custom endpoint", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false, + "UseGlobalEndpoint": true + } + }, + { + "documentation": "aws-global signs as us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseFIPS": true, + "Accelerate": false, + "UseDualStack": true + } + }, + { + "documentation": "aws-global signs as us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket.foo.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "https://foo.com" + } + }, + { + "documentation": "aws-global + dualstack + path-only bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": false + } + }, + { + "documentation": "aws-global + path-only bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3.amazonaws.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!" + } + }, + { + "documentation": "aws-global + fips + custom endpoint", + "expect": { + "error": "A custom endpoint cannot be combined with FIPS" + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": false, + "UseFIPS": true, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "aws-global, endpoint override & path only-bucket", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://foo.com/bucket%21" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket!", + "UseDualStack": false, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "aws-global + dualstack + custom endpoint", + "expect": { + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "params": { + "Region": "aws-global", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": false, + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "accelerate, dualstack + aws-global", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket.s3-accelerate.dualstack.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket", + "UseDualStack": true, + "UseFIPS": false, + "Accelerate": true + } + }, + { + "documentation": "FIPS + aws-global + path only bucket. This is not supported by S3 but we allow garbage in garbage out", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, @@ -12396,924 +14220,1106 @@ } }, "params": { - "Region": "us-east-1", + "Region": "aws-global", "Bucket": "bucket!", "ForcePathStyle": true, + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Accelerate": false } }, { - "documentation": "endpoint override + FIPS + dualstack (BUG)", + "documentation": "aws-global + FIPS + endpoint override.", "expect": { "error": "A custom endpoint cannot be combined with FIPS" }, "params": { - "Region": "us-east-1", - "Bucket": "bucket!", - "ForcePathStyle": true, + "Region": "aws-global", "UseFIPS": true, - "UseDualStack": false, "Endpoint": "http://foo.com" } }, { - "documentation": "endpoint override + non-dns bucket + FIPS (BUG)", + "documentation": "force path style, FIPS, aws-global & endpoint override", "expect": { "error": "A custom endpoint cannot be combined with FIPS" }, "params": { - "Region": "us-east-1", + "Region": "aws-global", "Bucket": "bucket!", + "ForcePathStyle": true, "UseFIPS": true, - "UseDualStack": false, "Endpoint": "http://foo.com" } }, { - "documentation": "FIPS + bucket endpoint + force path style", + "documentation": "ip address causes path style to be forced", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + "url": "http://192.168.1.1/bucket" } }, "params": { - "Region": "us-east-1", - "Bucket": "bucket!", - "ForcePathStyle": true, - "UseFIPS": true, - "UseDualStack": false, - "UseGlobalEndpoint": true + "Region": "aws-global", + "Bucket": "bucket", + "Endpoint": "http://192.168.1.1" } }, { - "documentation": "bucket + FIPS + force path style", + "documentation": "endpoint override with aws-global region", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket" - } + "error": "Cannot set dual-stack in combination with a custom endpoint." }, "params": { - "Region": "us-east-1", - "Bucket": "bucket", - "ForcePathStyle": true, + "Region": "aws-global", "UseFIPS": true, "UseDualStack": true, - "UseGlobalEndpoint": true + "Endpoint": "http://foo.com" } }, { - "documentation": "FIPS + dualstack + use global endpoint", + "documentation": "FIPS + path-only (TODO: consider making this an error)", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://bucket.s3-fips.dualstack.us-east-1.amazonaws.com" + "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" } }, "params": { - "Region": "us-east-1", - "Bucket": "bucket", - "UseFIPS": true, - "UseDualStack": true, - "UseGlobalEndpoint": true + "Region": "aws-global", + "Bucket": "bucket!", + "UseFIPS": true } }, { - "documentation": "URI encoded bucket + use global endpoint", + "documentation": "empty arn type", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "error": "Invalid ARN: No ARN type specified" }, "params": { - "Region": "us-east-1", + "Region": "us-east-2", + "Bucket": "arn:aws:not-s3:us-west-2:123456789012::myendpoint" + } + }, + { + "documentation": "path style can't be used with accelerate", + "expect": { + "error": "Path-style addressing cannot be used with S3 Accelerate" + }, + "params": { + "Region": "us-east-2", "Bucket": "bucket!", - "UseFIPS": true, - "UseDualStack": false, - "UseGlobalEndpoint": true, - "Endpoint": "https://foo.com" + "Accelerate": true } }, { - "documentation": "FIPS + path based endpoint", + "documentation": "invalid region", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Region": "us-east-2!", + "Bucket": "bucket.subdomain", + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "invalid region", + "expect": { + "error": "Invalid region: region was not a valid DNS name." + }, + "params": { + "Region": "us-east-2!", + "Bucket": "bucket", + "Endpoint": "http://foo.com" + } + }, + { + "documentation": "empty arn type", + "expect": { + "error": "Invalid Access Point Name" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3::123456789012:accesspoint:my_endpoint" + } + }, + { + "documentation": "empty arn type", + "expect": { + "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint`) has `aws-cn`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint", + "UseArnRegion": true + } + }, + { + "documentation": "invalid arn region", + "expect": { + "error": "Invalid region in ARN: `us-east_2` (invalid DNS name)" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-object-lambda:us-east_2:123456789012:accesspoint:my-endpoint", + "UseArnRegion": true + } + }, + { + "documentation": "invalid ARN outpost", + "expect": { + "error": "Invalid ARN: The outpost Id may only contain a-z, A-Z, 0-9 and `-`. Found: `op_01234567890123456`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op_01234567890123456/accesspoint/reports", + "UseArnRegion": true + } + }, + { + "documentation": "invalid ARN", + "expect": { + "error": "Invalid ARN: expected an access point name" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/reports" + } + }, + { + "documentation": "invalid ARN", + "expect": { + "error": "Invalid ARN: Expected a 4-component resource" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Expected an outpost type `accesspoint`, found not-accesspoint" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid region in ARN: `us-east_1` (invalid DNS name)" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east_1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `12345_789012`" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:12345_789012:outpost/op-01234567890123456/not-accesspoint/reports" + } + }, + { + "documentation": "invalid outpost type", + "expect": { + "error": "Invalid ARN: The Outpost Id was not set" + }, + "params": { + "Region": "us-east-2", + "Bucket": "arn:aws:s3-outposts:us-east-1:12345789012:outpost" + } + }, + { + "documentation": "use global endpoint virtual addressing", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + "url": "http://bucket.example.com" } }, "params": { - "Region": "us-east-1", - "Bucket": "bucket!", - "UseFIPS": true, - "UseDualStack": false, - "Accelerate": false, + "Region": "us-east-2", + "Bucket": "bucket", + "Endpoint": "http://example.com", "UseGlobalEndpoint": true } }, { - "documentation": "accelerate + dualstack + global endpoint", + "documentation": "global endpoint + ip address", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://bucket.s3-accelerate.dualstack.amazonaws.com" + "url": "http://192.168.0.1/bucket" } }, "params": { - "Region": "us-east-1", + "Region": "us-east-2", "Bucket": "bucket", - "UseFIPS": false, - "UseDualStack": true, - "Accelerate": true, + "Endpoint": "http://192.168.0.1", "UseGlobalEndpoint": true } }, { - "documentation": "dualstack + global endpoint + non URI safe bucket", + "documentation": "invalid outpost type", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + "url": "https://s3.us-east-2.amazonaws.com/bucket%21" } }, "params": { - "Region": "us-east-1", + "Region": "us-east-2", "Bucket": "bucket!", - "Accelerate": false, - "UseDualStack": true, - "UseFIPS": false, "UseGlobalEndpoint": true } }, { - "documentation": "FIPS + uri encoded bucket", + "documentation": "invalid outpost type", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + "url": "https://bucket.s3-accelerate.amazonaws.com" } }, "params": { - "Region": "us-east-1", - "Bucket": "bucket!", - "ForcePathStyle": true, - "Accelerate": false, - "UseDualStack": false, - "UseFIPS": true, - "UseGlobalEndpoint": true - } - }, - { - "documentation": "endpoint override + non-uri safe endpoint + force path style", - "expect": { - "error": "A custom endpoint cannot be combined with FIPS" - }, - "params": { - "Region": "us-east-1", - "Bucket": "bucket!", - "ForcePathStyle": true, - "Accelerate": false, - "UseDualStack": false, - "UseFIPS": true, - "Endpoint": "http://foo.com", + "Region": "us-east-2", + "Bucket": "bucket", + "Accelerate": true, "UseGlobalEndpoint": true } }, { - "documentation": "FIPS + Dualstack + global endpoint + non-dns bucket", + "documentation": "use global endpoint + custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true, - "signingRegion": "us-east-1" + "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + "url": "http://foo.com/bucket%21" } }, "params": { - "Region": "us-east-1", + "Region": "us-east-2", "Bucket": "bucket!", - "Accelerate": false, - "UseDualStack": true, - "UseFIPS": true, - "UseGlobalEndpoint": true - } - }, - { - "documentation": "endpoint override + FIPS + dualstack", - "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true, - "UseGlobalEndpoint": true, - "Endpoint": "http://foo.com" - } - }, - { - "documentation": "non-bucket endpoint override + dualstack + global endpoint", - "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, "UseGlobalEndpoint": true, "Endpoint": "http://foo.com" } }, { - "documentation": "Endpoint override + UseGlobalEndpoint + us-east-1", + "documentation": "use global endpoint, not us-east-1, force path style", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-2", + "name": "sigv4", + "signingName": "s3", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://foo.com/bucket%21" + } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, + "Region": "us-east-2", + "Bucket": "bucket!", "UseGlobalEndpoint": true, + "ForcePathStyle": true, "Endpoint": "http://foo.com" } }, { - "documentation": "non-FIPS partition with FIPS set + custom endpoint", - "expect": { - "error": "Partition does not support FIPS" - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false, - "UseGlobalEndpoint": true - } - }, - { - "documentation": "aws-global signs as us-east-1", + "documentation": "vanilla virtual addressing@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "UseFIPS": true, "Accelerate": false, - "UseDualStack": true + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "aws-global signs as us-east-1", + "documentation": "virtual addressing + dualstack@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://bucket.foo.com" + "url": "https://bucket-name.s3.dualstack.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket", - "UseDualStack": false, - "UseFIPS": false, "Accelerate": false, - "Endpoint": "https://foo.com" + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "aws-global + dualstack + path-only bucket", + "documentation": "accelerate + dualstack@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3.dualstack.us-east-1.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", "UseDualStack": true, - "UseFIPS": false, - "Accelerate": false + "UseFIPS": false } }, { - "documentation": "aws-global + path-only bucket", + "documentation": "accelerate (dualstack=false)@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3-accelerate.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!" + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "aws-global + fips + custom endpoint", + "documentation": "virtual addressing + fips@us-west-2", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3-fips.us-west-2.amazonaws.com" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "UseDualStack": false, - "UseFIPS": true, "Accelerate": false, - "Endpoint": "http://foo.com" + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "aws-global, endpoint override & path only-bucket", + "documentation": "virtual addressing + dualstack + fips@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "http://foo.com/bucket%21" + "url": "https://bucket-name.s3-fips.dualstack.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "UseDualStack": false, - "UseFIPS": false, "Accelerate": false, - "Endpoint": "http://foo.com" + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": true } }, { - "documentation": "aws-global + dualstack + custom endpoint", + "documentation": "accelerate + fips = error@us-west-2", "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." + "error": "Accelerate cannot be used with FIPS" }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "UseDualStack": true, - "UseFIPS": false, - "Accelerate": false, - "Endpoint": "http://foo.com" + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "accelerate, dualstack + aws-global", + "documentation": "vanilla virtual addressing@cn-north-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket.s3-accelerate.dualstack.us-east-1.amazonaws.com" + "url": "https://bucket-name.s3.cn-north-1.amazonaws.com.cn" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket", - "UseDualStack": true, - "UseFIPS": false, - "Accelerate": true + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "FIPS + aws-global + path only bucket. This is not supported by S3 but we allow garbage in garbage out", + "documentation": "virtual addressing + dualstack@cn-north-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.dualstack.us-east-1.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3.dualstack.cn-north-1.amazonaws.com.cn" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "ForcePathStyle": true, + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true, - "Accelerate": false + "UseFIPS": false } }, { - "documentation": "aws-global + FIPS + endpoint override.", + "documentation": "accelerate (dualstack=false)@cn-north-1", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "error": "S3 Accelerate cannot be used in this region" }, "params": { - "Region": "aws-global", - "UseFIPS": true, - "Endpoint": "http://foo.com" + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "force path style, FIPS, aws-global & endpoint override", + "documentation": "virtual addressing + fips@cn-north-1", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "error": "Partition does not support FIPS" }, "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "ForcePathStyle": true, - "UseFIPS": true, - "Endpoint": "http://foo.com" + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "ip address causes path style to be forced", + "documentation": "vanilla virtual addressing@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "http://192.168.1.1/bucket" + "url": "https://bucket-name.s3.af-south-1.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket", - "Endpoint": "http://192.168.1.1" - } - }, - { - "documentation": "endpoint override with aws-global region", - "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." - }, - "params": { - "Region": "aws-global", - "UseFIPS": true, - "UseDualStack": true, - "Endpoint": "http://foo.com" + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "FIPS + path-only (TODO: consider making this an error)", + "documentation": "virtual addressing + dualstack@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.us-east-1.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3.dualstack.af-south-1.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "aws-global", - "Bucket": "bucket!", - "UseFIPS": true - } - }, - { - "documentation": "empty arn type", - "expect": { - "error": "Invalid ARN: No ARN type specified" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:not-s3:us-west-2:123456789012::myendpoint" - } - }, - { - "documentation": "path style can't be used with accelerate", - "expect": { - "error": "Path-style addressing cannot be used with S3 Accelerate" - }, - "params": { - "Region": "us-east-2", - "Bucket": "bucket!", - "Accelerate": true - } - }, - { - "documentation": "invalid region", - "expect": { - "error": "Invalid region: region was not a valid DNS name." - }, - "params": { - "Region": "us-east-2!", - "Bucket": "bucket.subdomain", - "Endpoint": "http://foo.com" - } - }, - { - "documentation": "invalid region", - "expect": { - "error": "Invalid region: region was not a valid DNS name." - }, - "params": { - "Region": "us-east-2!", - "Bucket": "bucket", - "Endpoint": "http://foo.com" - } - }, - { - "documentation": "empty arn type", - "expect": { - "error": "Invalid Access Point Name" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3::123456789012:accesspoint:my_endpoint" - } - }, - { - "documentation": "empty arn type", - "expect": { - "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint`) has `aws-cn`" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3:cn-north-1:123456789012:accesspoint:my-endpoint", - "UseArnRegion": true - } - }, - { - "documentation": "invalid arn region", - "expect": { - "error": "Invalid region in ARN: `us-east_2` (invalid DNS name)" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-object-lambda:us-east_2:123456789012:accesspoint:my-endpoint", - "UseArnRegion": true - } - }, - { - "documentation": "invalid ARN outpost", - "expect": { - "error": "Invalid ARN: The outpost Id may only contain a-z, A-Z, 0-9 and `-`. Found: `op_01234567890123456`" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op_01234567890123456/accesspoint/reports", - "UseArnRegion": true - } - }, - { - "documentation": "invalid ARN", - "expect": { - "error": "Invalid ARN: expected an access point name" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/reports" - } - }, - { - "documentation": "invalid ARN", - "expect": { - "error": "Invalid ARN: Expected a 4-component resource" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456" - } - }, - { - "documentation": "invalid outpost type", - "expect": { - "error": "Expected an outpost type `accesspoint`, found not-accesspoint" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" - } - }, - { - "documentation": "invalid outpost type", - "expect": { - "error": "Invalid region in ARN: `us-east_1` (invalid DNS name)" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east_1:123456789012:outpost/op-01234567890123456/not-accesspoint/reports" - } - }, - { - "documentation": "invalid outpost type", - "expect": { - "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `12345_789012`" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:12345_789012:outpost/op-01234567890123456/not-accesspoint/reports" - } - }, - { - "documentation": "invalid outpost type", - "expect": { - "error": "Invalid ARN: The Outpost Id was not set" - }, - "params": { - "Region": "us-east-2", - "Bucket": "arn:aws:s3-outposts:us-east-1:12345789012:outpost" + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "use global endpoint virtual addressing", + "documentation": "accelerate + dualstack@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "http://bucket.example.com" + "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseDualStack": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket", - "Endpoint": "http://example.com", - "UseGlobalEndpoint": true + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false } }, { - "documentation": "global endpoint + ip address", + "documentation": "accelerate (dualstack=false)@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "http://192.168.0.1/bucket" + "url": "https://bucket-name.s3-accelerate.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket", - "Endpoint": "http://192.168.0.1", - "UseGlobalEndpoint": true + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "invalid outpost type", + "documentation": "virtual addressing + fips@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3.us-east-2.amazonaws.com/bucket%21" + "url": "https://bucket-name.s3-fips.af-south-1.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket!", - "UseGlobalEndpoint": true + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "invalid outpost type", + "documentation": "virtual addressing + dualstack + fips@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket.s3-accelerate.amazonaws.com" + "url": "https://bucket-name.s3-fips.dualstack.af-south-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "accelerate + fips = error@af-south-1", + "expect": { + "error": "Accelerate cannot be used with FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } } - }, + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket", "Accelerate": true, - "UseGlobalEndpoint": true + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "use global endpoint + custom endpoint", + "documentation": "vanilla path style@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", "name": "sigv4", "signingName": "s3", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "http://foo.com/bucket%21" + "url": "https://s3.us-west-2.amazonaws.com/bucket-name" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket!", - "UseGlobalEndpoint": true, - "Endpoint": "http://foo.com" + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": true, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "use global endpoint, not us-east-1, force path style", + "documentation": "fips@us-gov-west-2, bucket is not S3-dns-compatible (subdomains)", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "signingRegion": "us-east-2", - "name": "sigv4", "signingName": "s3", - "disableDoubleEncoding": true + "signingRegion": "us-gov-west-1", + "disableDoubleEncoding": true, + "name": "sigv4" } ] }, - "url": "http://foo.com/bucket%21" + "url": "https://s3-fips.us-gov-west-1.amazonaws.com/bucket.with.dots" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-west-1", + "AWS::UseFIPS": true, + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket.with.dots", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-2", - "Bucket": "bucket!", - "UseGlobalEndpoint": true, - "ForcePathStyle": true, - "Endpoint": "http://foo.com" + "Accelerate": false, + "Bucket": "bucket.with.dots", + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": true } }, { - "documentation": "vanilla virtual addressing@us-west-2", + "documentation": "path style + accelerate = error@us-west-2", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://bucket-name.s3.us-west-2.amazonaws.com" - } + "error": "Path-style addressing cannot be used with S3 Accelerate" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { @@ -13323,16 +15329,16 @@ } ], "params": { - "Accelerate": false, + "Accelerate": true, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + dualstack@us-west-2", + "documentation": "path style + dualstack@us-west-2", "expect": { "endpoint": { "properties": { @@ -13345,14 +15351,15 @@ } ] }, - "url": "https://bucket-name.s3.dualstack.us-west-2.amazonaws.com" + "url": "https://s3.dualstack.us-west-2.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::UseDualStack": true + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13364,54 +15371,41 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "us-west-2", "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "accelerate + dualstack@us-west-2", + "documentation": "path style + arn is error@us-west-2", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" - } + "error": "Path-style addressing cannot be used with ARN buckets" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, - "AWS::S3::Accelerate": true + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "bucket-name", - "ForcePathStyle": false, + "Accelerate": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, "Region": "us-west-2", - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "accelerate (dualstack=false)@us-west-2", + "documentation": "path style + invalid DNS name@us-west-2", "expect": { "endpoint": { "properties": { @@ -13424,33 +15418,33 @@ } ] }, - "url": "https://bucket-name.s3-accelerate.amazonaws.com" + "url": "https://s3.us-west-2.amazonaws.com/99a_b" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::Accelerate": true + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "99a_b", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "bucket-name", - "ForcePathStyle": false, + "Accelerate": false, + "Bucket": "99a_b", + "ForcePathStyle": true, "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + fips@us-west-2", + "documentation": "no path style + invalid DNS name@us-west-2", "expect": { "endpoint": { "properties": { @@ -13463,33 +15457,31 @@ } ] }, - "url": "https://bucket-name.s3-fips.us-west-2.amazonaws.com" + "url": "https://s3.us-west-2.amazonaws.com/99a_b" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "99a_b", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, + "Bucket": "99a_b", "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "virtual addressing + dualstack + fips@us-west-2", + "documentation": "vanilla path style@cn-north-1", "expect": { "endpoint": { "properties": { @@ -13497,20 +15489,19 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-west-2", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket-name.s3-fips.dualstack.us-west-2.amazonaws.com" + "url": "https://s3.cn-north-1.amazonaws.com.cn/bucket-name" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13522,23 +15513,23 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true + "ForcePathStyle": true, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "accelerate + fips = error@us-west-2", + "documentation": "path style + fips@cn-north-1", "expect": { - "error": "Accelerate cannot be used with FIPS" + "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", + "AWS::Region": "cn-north-1", "AWS::UseFIPS": true, - "AWS::S3::Accelerate": true + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13548,35 +15539,25 @@ } ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "us-west-2", + "ForcePathStyle": true, + "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "vanilla virtual addressing@cn-north-1", + "documentation": "path style + accelerate = error@cn-north-1", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://bucket-name.s3.cn-north-1.amazonaws.com.cn" - } + "error": "Path-style addressing cannot be used with S3 Accelerate" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { @@ -13586,16 +15567,16 @@ } ], "params": { - "Accelerate": false, + "Accelerate": true, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + dualstack@cn-north-1", + "documentation": "path style + dualstack@cn-north-1", "expect": { "endpoint": { "properties": { @@ -13608,14 +15589,15 @@ } ] }, - "url": "https://bucket-name.s3.dualstack.cn-north-1.amazonaws.com.cn" + "url": "https://s3.dualstack.cn-north-1.amazonaws.com.cn/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", - "AWS::UseDualStack": true + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13627,42 +15609,41 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "cn-north-1", "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "accelerate (dualstack=false)@cn-north-1", - "expect": { - "error": "S3 Accelerate cannot be used in this region" - }, - "params": { - "Accelerate": true, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "virtual addressing + fips@cn-north-1", + "documentation": "path style + arn is error@cn-north-1", "expect": { - "error": "Partition does not support FIPS" + "error": "Path-style addressing cannot be used with ARN buckets" }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Key": "key" + } + } + ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "vanilla virtual addressing@af-south-1", + "documentation": "path style + invalid DNS name@cn-north-1", "expect": { "endpoint": { "properties": { @@ -13670,37 +15651,38 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "af-south-1", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket-name.s3.af-south-1.amazonaws.com" + "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1" + "AWS::Region": "cn-north-1", + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "99a_b", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "af-south-1", + "Bucket": "99a_b", + "ForcePathStyle": true, + "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + dualstack@af-south-1", + "documentation": "no path style + invalid DNS name@cn-north-1", "expect": { "endpoint": { "properties": { @@ -13708,38 +15690,36 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "af-south-1", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket-name.s3.dualstack.af-south-1.amazonaws.com" + "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseDualStack": true + "AWS::Region": "cn-north-1" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "99a_b", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "af-south-1", - "UseDualStack": true, + "Bucket": "99a_b", + "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "accelerate + dualstack@af-south-1", + "documentation": "vanilla path style@af-south-1", "expect": { "endpoint": { "properties": { @@ -13752,15 +15732,14 @@ } ] }, - "url": "https://bucket-name.s3-accelerate.dualstack.amazonaws.com" + "url": "https://s3.af-south-1.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseDualStack": true, - "AWS::S3::Accelerate": true + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13770,36 +15749,37 @@ } ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "af-south-1", - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "accelerate (dualstack=false)@af-south-1", + "documentation": "path style + fips@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", "signingName": "s3", "signingRegion": "af-south-1", - "disableDoubleEncoding": true + "disableDoubleEncoding": true, + "name": "sigv4" } ] }, - "url": "https://bucket-name.s3-accelerate.amazonaws.com" + "url": "https://s3-fips.af-south-1.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::S3::Accelerate": true + "AWS::UseFIPS": true, + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13809,36 +15789,25 @@ } ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "af-south-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "virtual addressing + fips@af-south-1", + "documentation": "path style + accelerate = error@af-south-1", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://bucket-name.s3-fips.af-south-1.amazonaws.com" - } + "error": "Path-style addressing cannot be used with S3 Accelerate" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseFIPS": true + "AWS::S3::ForcePathStyle": true, + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { @@ -13848,16 +15817,16 @@ } ], "params": { - "Accelerate": false, + "Accelerate": true, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "af-south-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "virtual addressing + dualstack + fips@af-south-1", + "documentation": "path style + dualstack@af-south-1", "expect": { "endpoint": { "properties": { @@ -13870,15 +15839,15 @@ } ] }, - "url": "https://bucket-name.s3-fips.dualstack.af-south-1.amazonaws.com" + "url": "https://s3.dualstack.af-south-1.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::UseDualStack": true, + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { @@ -13890,42 +15859,41 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": false, + "ForcePathStyle": true, "Region": "af-south-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "accelerate + fips = error@af-south-1", + "documentation": "path style + arn is error@af-south-1", "expect": { - "error": "Accelerate cannot be used with FIPS" + "error": "Path-style addressing cannot be used with ARN buckets" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "AWS::S3::Accelerate": true + "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "bucket-name", - "ForcePathStyle": false, + "Accelerate": false, + "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "ForcePathStyle": true, "Region": "af-south-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "vanilla path style@us-west-2", + "documentation": "path style + invalid DNS name@af-south-1", "expect": { "endpoint": { "properties": { @@ -13933,86 +15901,95 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-west-2", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3.us-west-2.amazonaws.com/bucket-name" + "url": "https://s3.af-south-1.amazonaws.com/99a_b" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", + "AWS::Region": "af-south-1", "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "99a_b", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", + "Bucket": "99a_b", "ForcePathStyle": true, - "Region": "us-west-2", + "Region": "af-south-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "fips@us-gov-west-2, bucket is not S3-dns-compatible (subdomains)", + "documentation": "no path style + invalid DNS name@af-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { + "name": "sigv4", "signingName": "s3", - "signingRegion": "us-gov-west-1", - "disableDoubleEncoding": true, - "name": "sigv4" + "signingRegion": "af-south-1", + "disableDoubleEncoding": true } ] }, - "url": "https://s3-fips.us-gov-west-1.amazonaws.com/bucket.with.dots" + "url": "https://s3.af-south-1.amazonaws.com/99a_b" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-gov-west-1", - "AWS::UseFIPS": true, - "AWS::S3::ForcePathStyle": true + "AWS::Region": "af-south-1" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket.with.dots", + "Bucket": "99a_b", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket.with.dots", - "Region": "us-gov-west-1", + "Bucket": "99a_b", + "Region": "af-south-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "path style + accelerate = error@us-west-2", + "documentation": "virtual addressing + private link@us-west-2", "expect": { - "error": "Path-style addressing cannot be used with S3 Accelerate" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "http://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::ForcePathStyle": true, - "AWS::S3::Accelerate": true + "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { @@ -14022,16 +15999,17 @@ } ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + dualstack@us-west-2", + "documentation": "path style + private link@us-west-2", "expect": { "endpoint": { "properties": { @@ -14044,14 +16022,14 @@ } ] }, - "url": "https://s3.dualstack.us-west-2.amazonaws.com/bucket-name" + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", @@ -14065,79 +16043,101 @@ "Accelerate": false, "Bucket": "bucket-name", "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + arn is error@us-west-2", + "documentation": "SDK::Host + FIPS@us-west-2", "expect": { - "error": "Path-style addressing cannot be used with ARN buckets" + "error": "A custom endpoint cannot be combined with FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::ForcePathStyle": true + "AWS::UseFIPS": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Bucket": "bucket-name", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "ForcePathStyle": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "path style + invalid DNS name@us-west-2", + "documentation": "SDK::Host + DualStack@us-west-2", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] + "error": "Cannot set dual-stack in combination with a custom endpoint." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, - "url": "https://s3.us-west-2.amazonaws.com/99a_b" + "operationName": "GetObject", + "operationParams": { + "Bucket": "bucket-name", + "Key": "key" + } } + ], + "params": { + "Accelerate": false, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "us-west-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "SDK::HOST + accelerate@us-west-2", + "expect": { + "error": "A custom endpoint cannot be combined with S3 Accelerate" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "bucket-name", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "99a_b", - "ForcePathStyle": true, + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "no path style + invalid DNS name@us-west-2", + "documentation": "SDK::Host + access point ARN@us-west-2", "expect": { "endpoint": { "properties": { @@ -14150,31 +16150,34 @@ } ] }, - "url": "https://s3.us-west-2.amazonaws.com/99a_b" + "url": "https://myendpoint-123456789012.beta.example.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "99a_b", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "vanilla path style@cn-north-1", + "documentation": "virtual addressing + private link@cn-north-1", "expect": { "endpoint": { "properties": { @@ -14187,14 +16190,14 @@ } ] }, - "url": "https://s3.cn-north-1.amazonaws.com.cn/bucket-name" + "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { @@ -14206,22 +16209,35 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + fips@cn-north-1", + "documentation": "path style + private link@cn-north-1", "expect": { - "error": "Partition does not support FIPS" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", - "AWS::UseFIPS": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", @@ -14235,62 +16251,37 @@ "Accelerate": false, "Bucket": "bucket-name", "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "path style + accelerate = error@cn-north-1", + "documentation": "FIPS@cn-north-1", "expect": { - "error": "Path-style addressing cannot be used with S3 Accelerate" + "error": "Partition does not support FIPS" }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::S3::ForcePathStyle": true, - "AWS::S3::Accelerate": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "bucket-name", - "Key": "key" - } - } - ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": true } }, { - "documentation": "path style + dualstack@cn-north-1", + "documentation": "SDK::Host + DualStack@cn-north-1", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://s3.dualstack.cn-north-1.amazonaws.com.cn/bucket-name" - } + "error": "Cannot set dual-stack in combination with a custom endpoint." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseDualStack": true, - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { @@ -14302,41 +16293,30 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "cn-north-1", "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "path style + arn is error@cn-north-1", + "documentation": "SDK::HOST + accelerate@cn-north-1", "expect": { - "error": "Path-style addressing cannot be used with ARN buckets" + "error": "A custom endpoint cannot be combined with S3 Accelerate" }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::S3::ForcePathStyle": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "Key": "key" - } - } - ], "params": { - "Accelerate": false, - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "ForcePathStyle": true, + "Accelerate": true, + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + invalid DNS name@cn-north-1", + "documentation": "SDK::Host + access point ARN@cn-north-1", "expect": { "endpoint": { "properties": { @@ -14349,33 +16329,34 @@ } ] }, - "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" + "url": "https://myendpoint-123456789012.beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "99a_b", - "ForcePathStyle": true, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "no path style + invalid DNS name@cn-north-1", + "documentation": "virtual addressing + private link@af-south-1", "expect": { "endpoint": { "properties": { @@ -14383,36 +16364,39 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "cn-north-1", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://s3.cn-north-1.amazonaws.com.cn/99a_b" + "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "bucket-name", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "99a_b", - "Region": "cn-north-1", + "Bucket": "bucket-name", + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "Region": "af-south-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "vanilla path style@af-south-1", + "documentation": "path style + private link@af-south-1", "expect": { "endpoint": { "properties": { @@ -14425,13 +16409,14 @@ } ] }, - "url": "https://s3.af-south-1.amazonaws.com/bucket-name" + "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "AWS::S3::ForcePathStyle": true }, "operationName": "GetObject", @@ -14445,34 +16430,23 @@ "Accelerate": false, "Bucket": "bucket-name", "ForcePathStyle": true, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "af-south-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + fips@af-south-1", + "documentation": "SDK::Host + FIPS@af-south-1", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "signingName": "s3", - "signingRegion": "af-south-1", - "disableDoubleEncoding": true, - "name": "sigv4" - } - ] - }, - "url": "https://s3-fips.af-south-1.amazonaws.com/bucket-name" - } + "error": "A custom endpoint cannot be combined with FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseFIPS": true, - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { @@ -14484,23 +16458,24 @@ "params": { "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "af-south-1", "UseDualStack": false, "UseFIPS": true } }, { - "documentation": "path style + accelerate = error@af-south-1", + "documentation": "SDK::Host + DualStack@af-south-1", "expect": { - "error": "Path-style addressing cannot be used with S3 Accelerate" + "error": "Cannot set dual-stack in combination with a custom endpoint." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::S3::ForcePathStyle": true, - "AWS::S3::Accelerate": true + "AWS::UseDualStack": true, + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetObject", "operationParams": { @@ -14510,37 +16485,26 @@ } ], "params": { - "Accelerate": true, + "Accelerate": false, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "af-south-1", - "UseDualStack": false, + "UseDualStack": true, "UseFIPS": false } }, { - "documentation": "path style + dualstack@af-south-1", + "documentation": "SDK::HOST + accelerate@af-south-1", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://s3.dualstack.af-south-1.amazonaws.com/bucket-name" - } + "error": "A custom endpoint cannot be combined with S3 Accelerate" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::UseDualStack": true, - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { @@ -14550,43 +16514,57 @@ } ], "params": { - "Accelerate": false, + "Accelerate": true, "Bucket": "bucket-name", - "ForcePathStyle": true, + "ForcePathStyle": false, + "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "af-south-1", - "UseDualStack": true, + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + arn is error@af-south-1", + "documentation": "SDK::Host + access point ARN@af-south-1", "expect": { - "error": "Path-style addressing cannot be used with ARN buckets" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.beta.example.com" + } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", - "AWS::S3::ForcePathStyle": true + "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "arn:PARTITION:s3-outposts:REGION:123456789012:outpost:op-01234567890123456:bucket:mybucket", - "ForcePathStyle": true, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Endpoint": "https://beta.example.com", "Region": "af-south-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + invalid DNS name@af-south-1", + "documentation": "vanilla access point arn@us-west-2", "expect": { "endpoint": { "properties": { @@ -14594,38 +16572,37 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "af-south-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3.af-south-1.amazonaws.com/99a_b" + "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::S3::ForcePathStyle": true + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "99a_b", - "ForcePathStyle": true, - "Region": "af-south-1", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "no path style + invalid DNS name@af-south-1", + "documentation": "access point arn + FIPS@us-west-2", "expect": { "endpoint": { "properties": { @@ -14633,36 +16610,65 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "af-south-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://s3.af-south-1.amazonaws.com/99a_b" + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1" + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "99a_b", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "99a_b", - "Region": "af-south-1", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@us-west-2", + "expect": { + "error": "Access Points do not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": true, + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + private link@us-west-2", + "documentation": "access point arn + FIPS + DualStack@us-west-2", "expect": { "endpoint": { "properties": { @@ -14675,34 +16681,34 @@ } ] }, - "url": "http://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", "ForcePathStyle": false, - "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": true, + "UseFIPS": true } }, { - "documentation": "path style + private link@us-west-2", + "documentation": "vanilla access point arn@cn-north-1", "expect": { "endpoint": { "properties": { @@ -14710,127 +16716,196 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-west-2", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, - "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + "url": "https://myendpoint-123456789012.s3-accesspoint.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "AWS::S3::ForcePathStyle": true + "AWS::Region": "cn-north-1" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": true, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "us-west-2", + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "SDK::Host + FIPS@us-west-2", + "documentation": "access point arn + FIPS@cn-north-1", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@cn-north-1", + "expect": { + "error": "Access Points do not support S3 Accelerate" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true, - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "cn-north-1", + "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "bucket-name", + "Accelerate": true, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "us-west-2", + "Region": "cn-north-1", "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "access point arn + FIPS + DualStack@cn-north-1", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Accelerate": false, + "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": true } }, { - "documentation": "SDK::Host + DualStack@us-west-2", + "documentation": "vanilla access point arn@af-south-1", "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint.af-south-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "af-south-1" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "us-west-2", - "UseDualStack": true, + "Region": "af-south-1", + "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "SDK::HOST + accelerate@us-west-2", + "documentation": "access point arn + FIPS@af-south-1", "expect": { - "error": "A custom endpoint cannot be combined with S3 Accelerate" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "af-south-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.af-south-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Key": "key" + } + } + ], + "params": { + "Accelerate": false, + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "ForcePathStyle": false, + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "access point arn + accelerate = error@af-south-1", + "expect": { + "error": "Access Points do not support S3 Accelerate" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "af-south-1", "AWS::S3::Accelerate": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": true, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "ForcePathStyle": false, - "Endpoint": "http://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "us-west-2", + "Region": "af-south-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "SDK::Host + access point ARN@us-west-2", + "documentation": "access point arn + FIPS + DualStack@af-south-1", "expect": { "endpoint": { "properties": { @@ -14838,838 +16913,928 @@ { "name": "sigv4", "signingName": "s3", - "signingRegion": "us-west-2", + "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.beta.example.com" + "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "af-south-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", "ForcePathStyle": false, - "Endpoint": "https://beta.example.com", - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true } }, { - "documentation": "virtual addressing + private link@cn-north-1", + "documentation": "S3 outposts vanilla test", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "cn-north-1", + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" } }, { - "documentation": "path style + private link@cn-north-1", + "documentation": "S3 outposts custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", + "signingName": "s3-outposts", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + "url": "https://reports-123456789012.op-01234567890123456.example.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "AWS::S3::ForcePathStyle": true + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://example.amazonaws.com" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": true, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "cn-north-1", + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "FIPS@cn-north-1", - "expect": { - "error": "Partition does not support FIPS" - }, - "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Endpoint": "https://example.amazonaws.com" } }, { - "documentation": "SDK::Host + DualStack@cn-north-1", + "documentation": "outposts arn with region mismatch and UseArnRegion=false", "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::UseDualStack": true, - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "SDK::HOST + accelerate@cn-north-1", - "expect": { - "error": "A custom endpoint cannot be combined with S3 Accelerate" - }, - "params": { - "Accelerate": true, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "cn-north-1", + "UseArnRegion": false, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "SDK::Host + access point ARN@cn-north-1", + "documentation": "outposts arn with region mismatch, custom region and UseArnRegion=false", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://myendpoint-123456789012.beta.example.com" - } + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://example.com", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Endpoint": "https://example.com", "ForcePathStyle": false, - "Endpoint": "https://beta.example.com", - "Region": "cn-north-1", + "UseArnRegion": false, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "virtual addressing + private link@af-south-1", + "documentation": "outposts arn with region mismatch and UseArnRegion=true", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://bucket-name.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "af-south-1", + "UseArnRegion": true, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "path style + private link@af-south-1", + "documentation": "outposts arn with region mismatch and UseArnRegion unset", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com/bucket-name" + "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "AWS::S3::ForcePathStyle": true + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": true, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "af-south-1", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "ForcePathStyle": false, + "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "SDK::Host + FIPS@af-south-1", + "documentation": "outposts arn with partition mismatch and UseArnRegion=true", "expect": { - "error": "A custom endpoint cannot be combined with FIPS" + "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint`) has `aws-cn`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "af-south-1", + "UseArnRegion": true, + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": false } }, { - "documentation": "SDK::Host + DualStack@af-south-1", + "documentation": "ARN with UseGlobalEndpoint and use-east-1 region uses the regional endpoint", "expect": { - "error": "Cannot set dual-stack in combination with a custom endpoint." + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseDualStack": true, - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" + "AWS::Region": "us-east-1", + "AWS::S3::UseGlobalEndpoint": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "bucket-name", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports", "Key": "key" } } ], "params": { + "Region": "us-east-1", + "UseGlobalEndpoint": true, + "UseFIPS": false, + "UseDualStack": false, "Accelerate": false, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "af-south-1", + "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts does not support dualstack", + "expect": { + "error": "S3 Outposts does not support Dual-stack" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" } }, { - "documentation": "SDK::HOST + accelerate@af-south-1", + "documentation": "S3 outposts does not support fips", "expect": { - "error": "A custom endpoint cannot be combined with S3 Accelerate" + "error": "S3 Outposts does not support FIPS" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "S3 outposts does not support accelerate", + "expect": { + "error": "S3 Outposts does not support S3 Accelerate" }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "af-south-1", - "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "AWS::S3::Accelerate": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "bucket-name", - "Key": "key" - } - } - ], "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, "Accelerate": true, - "Bucket": "bucket-name", - "ForcePathStyle": false, - "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", - "Region": "af-south-1", + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + } + }, + { + "documentation": "validates against subresource", + "expect": { + "error": "Invalid Arn: Outpost Access Point ARN contains sub resources" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:mybucket:object:foo" } }, { - "documentation": "SDK::Host + access point ARN@af-south-1", + "documentation": "object lambda @us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.beta.example.com" + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "SDK::Endpoint": "https://beta.example.com" + "AWS::Region": "us-east-1", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Endpoint": "https://beta.example.com", - "Region": "af-south-1", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "vanilla access point arn@us-west-2", + "documentation": "object lambda @us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", + "signingName": "s3-object-lambda", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com" + "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + FIPS@us-west-2", + "documentation": "object lambda, colon resource deliminator @us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", + "signingName": "s3-object-lambda", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint-fips.us-west-2.amazonaws.com" + "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::UseFIPS": true + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner" } }, { - "documentation": "access point arn + accelerate = error@us-west-2", + "documentation": "object lambda @us-east-1, client region us-west-2, useArnRegion=true", "expect": { - "error": "Access Points do not support S3 Accelerate" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::Accelerate": true + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + FIPS + DualStack@us-west-2", + "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=true", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "us-west-2", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.us-west-2.amazonaws.com" + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::Region": "s3-external-1", + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { + "Region": "s3-external-1", + "UseFIPS": false, + "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3:us-west-2:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "vanilla access point arn@cn-north-1", + "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=false", + "expect": { + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `s3-external-1` and UseArnRegion is `false`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "s3-external-1", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "s3-external-1", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=true", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "cn-north-1", + "signingName": "s3-object-lambda", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint.cn-north-1.amazonaws.com.cn" + "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1" + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "cn-north-1", + "Region": "aws-global", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + FIPS@cn-north-1", + "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=false", "expect": { - "error": "Partition does not support FIPS" + "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `aws-global` and UseArnRegion is `false`" }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": false + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "cn-north-1", + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @cn-north-1, client region us-west-2 (cross partition), useArnRegion=true", + "expect": { + "error": "Client was configured for partition `aws` but ARN (`arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner`) has `aws-cn`" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "aws-global", + "AWS::S3::UseArnRegion": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner", + "Key": "key" + } + } + ], + "params": { + "Region": "aws-global", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + accelerate = error@cn-north-1", + "documentation": "object lambda with dualstack", "expect": { - "error": "Access Points do not support S3 Accelerate" + "error": "S3 Object Lambda does not support Dual-stack" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "cn-north-1", - "AWS::S3::Accelerate": true + "AWS::Region": "us-west-2", + "AWS::UseDualStack": true, + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "access point arn + FIPS + DualStack@cn-north-1", - "expect": { - "error": "Partition does not support FIPS" - }, - "params": { - "Accelerate": false, - "Bucket": "arn:aws-cn:s3:cn-north-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "cn-north-1", + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": true + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" } }, { - "documentation": "vanilla access point arn@af-south-1", + "documentation": "object lambda @us-gov-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", + "signingName": "s3-object-lambda", + "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint.af-south-1.amazonaws.com" + "url": "https://mybanner-123456789012.s3-object-lambda.us-gov-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "af-south-1" - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "Key": "key" - } - } - ], "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "af-south-1", + "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + FIPS@af-south-1", + "documentation": "object lambda @us-gov-east-1, with fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", + "signingName": "s3-object-lambda", + "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myendpoint-123456789012.s3-accesspoint-fips.af-south-1.amazonaws.com" + "url": "https://mybanner-123456789012.s3-object-lambda-fips.us-gov-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseFIPS": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "Key": "key" - } - } - ], "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "af-south-1", + "UseArnRegion": false, + "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda @cn-north-1, with fips", + "expect": { + "error": "Partition does not support FIPS" + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + accelerate = error@af-south-1", + "documentation": "object lambda with accelerate", "expect": { - "error": "Access Points do not support S3 Accelerate" + "error": "S3 Object Lambda does not support S3 Accelerate" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::S3::Accelerate": true + "AWS::Region": "us-west-2", + "AWS::S3::Accelerate": true, + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { - "Accelerate": true, - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "af-south-1", + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": true, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" } }, { - "documentation": "access point arn + FIPS + DualStack@af-south-1", + "documentation": "object lambda with invalid arn - bad service and someresource", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "af-south-1", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://myendpoint-123456789012.s3-accesspoint-fips.dualstack.af-south-1.amazonaws.com" - } + "error": "Invalid ARN: Unrecognized format: arn:aws:sqs:us-west-2:123456789012:someresource (type: someresource)" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "af-south-1", - "AWS::UseFIPS": true, - "AWS::UseDualStack": true + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", + "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource", "Key": "key" } } ], "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3:af-south-1:123456789012:accesspoint:myendpoint", - "ForcePathStyle": false, - "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseArnRegion": false, + "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource" } }, { - "documentation": "S3 outposts vanilla test", + "documentation": "object lambda with invalid arn - invalid resource", "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-2", - "disableDoubleEncoding": true - } - ] - }, - "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-west-2.amazonaws.com" - } + "error": "Invalid ARN: Object Lambda ARNs only support `accesspoint` arn types, but found: `bucket_name`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:bucket_name:mybucket" + } + }, + { + "documentation": "object lambda with invalid arn - missing region", + "expect": { + "error": "Invalid ARN: bucket ARN is missing a region" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda::123456789012:accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with invalid arn - missing account-id", + "expect": { + "error": "Invalid ARN: Missing account id" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2::accesspoint/mybanner" + } + }, + { + "documentation": "object lambda with invalid arn - account id contains invalid characters", + "expect": { + "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `123.45678.9012`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-west-2", + "AWS::S3::UseArnRegion": true }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket", "Key": "key" } } @@ -15679,43 +17844,93 @@ "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket" } }, { - "documentation": "S3 outposts custom endpoint", + "documentation": "object lambda with invalid arn - missing access point name", + "expect": { + "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains invalid character: *", + "expect": { + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `*`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:*" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains invalid character: .", + "expect": { + "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `my.bucket`" + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:my.bucket" + } + }, + { + "documentation": "object lambda with invalid arn - access point name contains sub resources", + "expect": { + "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`." + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseArnRegion": true, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybucket:object:foo" + } + }, + { + "documentation": "object lambda with custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, { "name": "sigv4", - "signingName": "s3-outposts", + "signingName": "s3-object-lambda", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://reports-123456789012.op-01234567890123456.example.amazonaws.com" + "url": "https://mybanner-123456789012.my-endpoint.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://example.amazonaws.com" + "SDK::Endpoint": "https://my-endpoint.com", + "AWS::S3::UseArnRegion": false }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", "Key": "key" } } @@ -15725,12 +17940,13 @@ "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports", - "Endpoint": "https://example.amazonaws.com" + "UseArnRegion": false, + "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Endpoint": "https://my-endpoint.com" } }, { - "documentation": "outposts arn with region mismatch and UseArnRegion=false", + "documentation": "object lambda arn with region mismatch and UseArnRegion=false", "expect": { "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, @@ -15742,14 +17958,14 @@ }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "Key": "key" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", + "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", "ForcePathStyle": false, "UseArnRegion": false, "Region": "us-west-2", @@ -15758,258 +17974,223 @@ } }, { - "documentation": "outposts arn with region mismatch, custom region and UseArnRegion=false", + "documentation": "WriteGetObjectResponse @ us-west-2", "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://s3-object-lambda.us-west-2.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://example.com", - "AWS::S3::UseArnRegion": false + "AWS::Region": "us-west-2" }, - "operationName": "GetObject", + "operationName": "WriteGetObjectResponse", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Key": "key" + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Endpoint": "https://example.com", - "ForcePathStyle": false, - "UseArnRegion": false, + "UseObjectLambdaEndpoint": true, "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "outposts arn with region mismatch and UseArnRegion=true", + "documentation": "WriteGetObjectResponse with custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, { "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "signingName": "s3-object-lambda", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, - "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + "url": "https://my-endpoint.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": true + "SDK::Endpoint": "https://my-endpoint.com" }, - "operationName": "GetObject", + "operationName": "WriteGetObjectResponse", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Key": "key" + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "ForcePathStyle": false, - "UseArnRegion": true, + "UseObjectLambdaEndpoint": true, + "Endpoint": "https://my-endpoint.com", "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "outposts arn with region mismatch and UseArnRegion unset", + "documentation": "WriteGetObjectResponse @ us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, { "name": "sigv4", - "signingName": "s3-outposts", + "signingName": "s3-object-lambda", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://myaccesspoint-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" - } - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2" - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Key": "key" - } + "url": "https://s3-object-lambda.us-east-1.amazonaws.com" } - ], - "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "ForcePathStyle": false, - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "outposts arn with partition mismatch and UseArnRegion=true", - "expect": { - "error": "Client was configured for partition `aws` but ARN (`arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint`) has `aws-cn`" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": true + "AWS::Region": "us-east-1" }, - "operationName": "GetObject", + "operationName": "WriteGetObjectResponse", "operationParams": { - "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "Key": "key" + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" } } ], "params": { "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", - "ForcePathStyle": false, - "UseArnRegion": true, - "Region": "us-west-2", + "UseObjectLambdaEndpoint": true, + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false } }, { - "documentation": "ARN with UseGlobalEndpoint and use-east-1 region uses the regional endpoint", + "documentation": "WriteGetObjectResponse with fips", "expect": { "endpoint": { "properties": { "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, { "name": "sigv4", - "signingName": "s3-outposts", + "signingName": "s3-object-lambda", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://reports-123456789012.op-01234567890123456.s3-outposts.us-east-1.amazonaws.com" + "url": "https://s3-object-lambda-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", - "AWS::S3::UseGlobalEndpoint": true + "AWS::UseFIPS": true }, - "operationName": "GetObject", + "operationName": "WriteGetObjectResponse", "operationParams": { - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports", - "Key": "key" + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" } } ], "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, "Region": "us-east-1", - "UseGlobalEndpoint": true, - "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-01234567890123456/accesspoint/reports" + "UseFIPS": true } }, { - "documentation": "S3 outposts does not support dualstack", + "documentation": "WriteGetObjectResponse with dualstack", "expect": { - "error": "S3 Outposts does not support Dual-stack" + "error": "S3 Object Lambda does not support Dual-stack" }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "WriteGetObjectResponse", + "operationParams": { + "RequestRoute": "RequestRoute", + "RequestToken": "RequestToken" + } + } + ], "params": { + "Accelerate": false, + "UseObjectLambdaEndpoint": true, "Region": "us-east-1", - "UseFIPS": false, "UseDualStack": true, - "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + "UseFIPS": false } }, { - "documentation": "S3 outposts does not support fips", + "documentation": "WriteGetObjectResponse with accelerate", "expect": { - "error": "S3 Outposts does not support FIPS" + "error": "S3 Object Lambda does not support S3 Accelerate" }, "params": { + "Accelerate": true, + "UseObjectLambdaEndpoint": true, "Region": "us-east-1", - "UseFIPS": true, "UseDualStack": false, - "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + "UseFIPS": false } }, { - "documentation": "S3 outposts does not support accelerate", + "documentation": "WriteGetObjectResponse with fips in CN", "expect": { - "error": "S3 Outposts does not support S3 Accelerate" + "error": "Partition does not support FIPS" }, "params": { - "Region": "us-east-1", - "UseFIPS": false, + "Accelerate": false, + "Region": "cn-north-1", + "UseObjectLambdaEndpoint": true, "UseDualStack": false, - "Accelerate": true, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost/op-01234567890123456/accesspoint/reports" + "UseFIPS": true } }, { - "documentation": "validates against subresource", + "documentation": "WriteGetObjectResponse with invalid partition", "expect": { - "error": "Invalid Arn: Outpost Access Point ARN contains sub resources" + "error": "Invalid region: region was not a valid DNS name." }, "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false, "Accelerate": false, - "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:mybucket:object:foo" + "UseObjectLambdaEndpoint": true, + "Region": "not a valid DNS name", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "object lambda @us-east-1", + "documentation": "WriteGetObjectResponse with an unknown partition", "expect": { "endpoint": { "properties": { @@ -16017,670 +18198,666 @@ { "name": "sigv4", "signingName": "s3-object-lambda", - "signingRegion": "us-east-1", - "disableDoubleEncoding": true + "disableDoubleEncoding": true, + "signingRegion": "us-east.special" } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + "url": "https://s3-object-lambda.us-east.special.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "UseObjectLambdaEndpoint": true, + "Region": "us-east.special", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "object lambda @us-west-2", + "documentation": "S3 Outposts bucketAlias Real Outpost Prod us-west-1", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-west-2", + "signingName": "s3-outposts", + "signingRegion": "us-west-1", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.us-west-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "us-west-2", + "Region": "us-west-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda, colon resource deliminator @us-west-2", + "documentation": "S3 Outposts bucketAlias Real Outpost Prod ap-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-west-2", + "signingName": "s3-outposts", + "signingRegion": "ap-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-west-2.amazonaws.com" + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.ap-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "us-west-2", + "Region": "ap-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-east-1, client region us-west-2, useArnRegion=true", + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3-object-lambda", + "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.us-east-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "us-west-2", + "Region": "us-east-1", + "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=true", + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod me-south-1", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-east-1", + "signingName": "s3-outposts", + "signingRegion": "me-south-1", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.me-south-1.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "s3-external-1", - "AWS::S3::UseArnRegion": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "s3-external-1", + "Region": "me-south-1", + "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-east-1, client region s3-external-1, useArnRegion=false", + "documentation": "S3 Outposts bucketAlias Real Outpost Beta", "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `s3-external-1` and UseArnRegion is `false`" - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "s3-external-1", - "AWS::S3::UseArnRegion": false + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, + { + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } + "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3.op-0b1d075431d83bebd.example.amazonaws.com" } - ], + }, "params": { - "Region": "s3-external-1", + "Region": "us-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", + "Endpoint": "https://example.amazonaws.com", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=true", + "documentation": "S3 Outposts bucketAlias Ec2 Outpost Beta", "expect": { "endpoint": { "properties": { "authSchemes": [ + { + "name": "sigv4a", + "signingName": "s3-outposts", + "signingRegionSet": [ + "*" + ], + "disableDoubleEncoding": true + }, { "name": "sigv4", - "signingName": "s3-object-lambda", + "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-east-1.amazonaws.com" + "url": "https://161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3.ec2.example.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "aws-global", - "AWS::S3::UseArnRegion": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "aws-global", + "Region": "us-east-1", + "Bucket": "161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3", + "Endpoint": "https://example.amazonaws.com", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-east-1, client region aws-global, useArnRegion=false", + "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `aws-global` and UseArnRegion is `false`" + "error": "Expected a endpoint to be specified but no endpoint was found" }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "aws-global", - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "aws-global", + "Region": "us-east-1", + "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @cn-north-1, client region us-west-2 (cross partition), useArnRegion=true", + "documentation": "S3 Outposts bucketAlias Invalid hardware type", "expect": { - "error": "Client was configured for partition `aws` but ARN (`arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner`) has `aws-cn`" + "error": "Unrecognized hardware type: \"Expected hardware type o or e but got h\"" }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "aws-global", - "AWS::S3::UseArnRegion": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "aws-global", + "Region": "us-east-1", + "Bucket": "test-accessp-h0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda with dualstack", + "documentation": "S3 Outposts bucketAlias Special character in Outpost Arn", "expect": { - "error": "S3 Object Lambda does not support Dual-stack" + "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`." }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseDualStack": true, - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], "params": { - "Region": "us-west-2", + "Region": "us-east-1", + "Bucket": "test-accessp-o00000754%1d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", "UseFIPS": false, - "UseDualStack": true, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + "UseDualStack": false, + "Accelerate": false } }, { - "documentation": "object lambda @us-gov-east-1", + "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", + "expect": { + "error": "Expected a endpoint to be specified but no endpoint was found" + }, + "params": { + "Region": "us-east-1", + "Bucket": "test-accessp-e0b1d075431d83bebde8xz5w8ijx1qzlbp3i3ebeta0--op-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false + } + }, + { + "documentation": "S3 Snow with bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-gov-east-1", + "signingName": "s3", + "signingRegion": "snow", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda.us-gov-east-1.amazonaws.com" + "url": "http://10.0.1.12:433/bucketName" } }, "params": { - "Region": "us-gov-east-1", + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "http://10.0.1.12:433", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda @us-gov-east-1, with fips", + "documentation": "S3 Snow without bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-gov-east-1", + "signingName": "s3", + "signingRegion": "snow", "disableDoubleEncoding": true } ] }, - "url": "https://mybanner-123456789012.s3-object-lambda-fips.us-gov-east-1.amazonaws.com" + "url": "https://10.0.1.12:433" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws-us-gov:s3-object-lambda:us-gov-east-1:123456789012:accesspoint/mybanner" - } - }, - { - "documentation": "object lambda @cn-north-1, with fips", - "expect": { - "error": "Partition does not support FIPS" - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws-cn:s3-object-lambda:cn-north-1:123456789012:accesspoint/mybanner" - } - }, - { - "documentation": "object lambda with accelerate", - "expect": { - "error": "S3 Object Lambda does not support S3 Accelerate" - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::Accelerate": true, - "AWS::S3::UseArnRegion": false - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", - "Key": "key" - } - } - ], - "params": { - "Region": "us-west-2", + "Region": "snow", + "Endpoint": "https://10.0.1.12:433", "UseFIPS": false, "UseDualStack": false, - "Accelerate": true, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda with invalid arn - bad service and someresource", + "documentation": "S3 Snow no port", "expect": { - "error": "Invalid ARN: Unrecognized format: arn:aws:sqs:us-west-2:123456789012:someresource (type: someresource)" - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": false + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource", - "Key": "key" - } + "url": "http://10.0.1.12/bucketName" } - ], - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:sqs:us-west-2:123456789012:someresource" - } - }, - { - "documentation": "object lambda with invalid arn - invalid resource", - "expect": { - "error": "Invalid ARN: Object Lambda ARNs only support `accesspoint` arn types, but found: `bucket_name`" - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:bucket_name:mybucket" - } - }, - { - "documentation": "object lambda with invalid arn - missing region", - "expect": { - "error": "Invalid ARN: bucket ARN is missing a region" }, "params": { - "Region": "us-west-2", + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "http://10.0.1.12", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda::123456789012:accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda with invalid arn - missing account-id", + "documentation": "S3 Snow dns endpoint", "expect": { - "error": "Invalid ARN: Missing account id" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "snow", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://amazonaws.com/bucketName" + } }, "params": { - "Region": "us-west-2", + "Region": "snow", + "Bucket": "bucketName", + "Endpoint": "https://amazonaws.com", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2::accesspoint/mybanner" + "Accelerate": false } }, { - "documentation": "object lambda with invalid arn - account id contains invalid characters", + "documentation": "Data Plane with short zone name", "expect": { - "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `123.45678.9012`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--abcd-ab1--x-s3.s3express-abcd-ab1.us-east-1.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": true + "AWS::Region": "us-east-1" }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket", + "Bucket": "mybucket--abcd-ab1--x-s3", "Key": "key" } } ], "params": { - "Region": "us-west-2", + "Region": "us-east-1", + "Bucket": "mybucket--abcd-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123.45678.9012:accesspoint:mybucket" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda with invalid arn - missing access point name", + "documentation": "Data Plane with short zone name china region", "expect": { - "error": "Invalid ARN: Expected a resource of the format `accesspoint:` but no name was provided" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--abcd-ab1--x-s3.s3express-abcd-ab1.cn-north-1.amazonaws.com.cn" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--abcd-ab1--x-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-west-2", + "Region": "cn-north-1", + "Bucket": "mybucket--abcd-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda with invalid arn - access point name contains invalid character: *", + "documentation": "Data Plane with short zone name with AP", "expect": { - "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `*`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://myaccesspoint--abcd-ab1--xa-s3.s3express-abcd-ab1.us-east-1.amazonaws.com" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--abcd-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-west-2", + "Region": "us-east-1", + "Bucket": "myaccesspoint--abcd-ab1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:*" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda with invalid arn - access point name contains invalid character: .", + "documentation": "Data Plane with short zone name with AP china region", "expect": { - "error": "Invalid ARN: The access point name may only contain a-z, A-Z, 0-9 and `-`. Found: `my.bucket`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "cn-north-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://myaccesspoint--abcd-ab1--xa-s3.s3express-abcd-ab1.cn-north-1.amazonaws.com.cn" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--abcd-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-west-2", + "Region": "cn-north-1", + "Bucket": "myaccesspoint--abcd-ab1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:my.bucket" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda with invalid arn - access point name contains sub resources", + "documentation": "Data Plane with short zone names (13 chars)", "expect": { - "error": "Invalid ARN: The ARN may only contain a single resource component after `accesspoint`." + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-zone-ab1--x-s3", + "Key": "key" + } + } + ], "params": { "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": true, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint:mybucket:object:foo" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda with custom endpoint", + "documentation": "Data Plane with short zone names (13 chars) with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", + "name": "sigv4-s3express", + "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://mybanner-123456789012.my-endpoint.com" + "url": "https://myaccesspoint--test-zone-ab1--xa-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://my-endpoint.com", - "AWS::S3::UseArnRegion": false + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", "Key": "key" } } ], "params": { "Region": "us-west-2", + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseArnRegion": false, - "Bucket": "arn:aws:s3-object-lambda:us-west-2:123456789012:accesspoint/mybanner", - "Endpoint": "https://my-endpoint.com" + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "object lambda arn with region mismatch and UseArnRegion=false", + "documentation": "Data Plane with medium zone names (14 chars)", "expect": { - "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" + } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::S3::UseArnRegion": false + "AWS::Region": "us-west-2" }, "operationName": "GetObject", "operationParams": { - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", + "Bucket": "mybucket--test1-zone-ab1--x-s3", "Key": "key" } } ], "params": { - "Accelerate": false, - "Bucket": "arn:aws:s3-object-lambda:us-east-1:123456789012:accesspoint/mybanner", - "ForcePathStyle": false, - "UseArnRegion": false, "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse @ us-west-2", + "documentation": "Data Plane with medium zone names (14 chars) with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", + "name": "sigv4-s3express", + "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://s3-object-lambda.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-zone-ab1--xa-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" } }, "operationInputs": [ @@ -16688,112 +18865,116 @@ "builtInParams": { "AWS::Region": "us-west-2" }, - "operationName": "WriteGetObjectResponse", + "operationName": "GetObject", "operationParams": { - "RequestRoute": "RequestRoute", - "RequestToken": "RequestToken" + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", + "Key": "key" } } ], "params": { - "Accelerate": false, - "UseObjectLambdaEndpoint": true, "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with custom endpoint", + "documentation": "Data Plane with long zone names (20 chars)", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", + "name": "sigv4-s3express", + "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://my-endpoint.com" + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2", - "SDK::Endpoint": "https://my-endpoint.com" + "AWS::Region": "us-west-2" }, - "operationName": "WriteGetObjectResponse", + "operationName": "GetObject", "operationParams": { - "RequestRoute": "RequestRoute", - "RequestToken": "RequestToken" + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Key": "key" } } ], "params": { - "Accelerate": false, - "UseObjectLambdaEndpoint": true, - "Endpoint": "https://my-endpoint.com", "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse @ us-east-1", + "documentation": "Data Plane with long zone names (20 chars)", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", - "signingRegion": "us-east-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://s3-object-lambda.us-east-1.amazonaws.com" + "url": "https://myaccesspoint--test1-long1-zone-ab1--xa-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1" + "AWS::Region": "us-west-2" }, - "operationName": "WriteGetObjectResponse", + "operationName": "GetObject", "operationParams": { - "RequestRoute": "RequestRoute", - "RequestToken": "RequestToken" + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", + "Key": "key" } } ], "params": { - "Accelerate": false, - "UseObjectLambdaEndpoint": true, - "Region": "us-east-1", + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with fips", + "documentation": "Data Plane with short zone fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", + "name": "sigv4-s3express", + "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://s3-object-lambda-fips.us-east-1.amazonaws.com" + "url": "https://mybucket--test-ab1--x-s3.s3express-fips-test-ab1.us-east-1.amazonaws.com" } }, "operationInputs": [ @@ -16802,474 +18983,522 @@ "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, - "operationName": "WriteGetObjectResponse", + "operationName": "GetObject", "operationParams": { - "RequestRoute": "RequestRoute", - "RequestToken": "RequestToken" + "Bucket": "mybucket--test-ab1--x-s3", + "Key": "key" } } ], "params": { - "Accelerate": false, - "UseObjectLambdaEndpoint": true, "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with dualstack", + "documentation": "Data Plane with short zone fips china region", "expect": { - "error": "S3 Object Lambda does not support Dual-stack" + "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseDualStack": true + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true }, - "operationName": "WriteGetObjectResponse", + "operationName": "GetObject", "operationParams": { - "RequestRoute": "RequestRoute", - "RequestToken": "RequestToken" + "Bucket": "mybucket--test-ab1--x-s3", + "Key": "key" } } ], "params": { + "Region": "cn-north-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, "Accelerate": false, - "UseObjectLambdaEndpoint": true, - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with accelerate", + "documentation": "Data Plane with short zone fips with AP", "expect": { - "error": "S3 Object Lambda does not support S3 Accelerate" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://myaccesspoint--test-ab1--xa-s3.s3express-fips-test-ab1.us-east-1.amazonaws.com" + } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Accelerate": true, - "UseObjectLambdaEndpoint": true, "Region": "us-east-1", + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with fips in CN", + "documentation": "Data Plane with short zone fips with AP china region", "expect": { "error": "Partition does not support FIPS" }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Accelerate": false, "Region": "cn-north-1", - "UseObjectLambdaEndpoint": true, + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "WriteGetObjectResponse with invalid partition", - "expect": { - "error": "Invalid region: region was not a valid DNS name." - }, - "params": { "Accelerate": false, - "UseObjectLambdaEndpoint": true, - "Region": "not a valid DNS name", - "UseDualStack": false, - "UseFIPS": false + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "WriteGetObjectResponse with an unknown partition", + "documentation": "Data Plane with short zone (13 chars) fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3-object-lambda", - "disableDoubleEncoding": true, - "signingRegion": "us-east.special" + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://s3-object-lambda.us-east.special.amazonaws.com" + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" } }, - "params": { - "Accelerate": false, - "UseObjectLambdaEndpoint": true, - "Region": "us-east.special", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "S3 Outposts bucketAlias Real Outpost Prod us-west-1", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-west-1", - "disableDoubleEncoding": true - } - ] + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true }, - "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.us-west-1.amazonaws.com" + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test-zone-ab1--x-s3", + "Key": "key" + } } - }, + ], "params": { - "Region": "us-west-1", - "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "mybucket--test-zone-ab1--x-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Outposts bucketAlias Real Outpost Prod ap-east-1", + "documentation": "Data Plane with short zone (13 chars) fips with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "ap-east-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.op-0b1d075431d83bebd.s3-outposts.ap-east-1.amazonaws.com" + "url": "https://myaccesspoint--test-zone-ab1--xa-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "ap-east-1", - "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod us-east-1", + "documentation": "Data Plane with medium zone (14 chars) fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.us-east-1.amazonaws.com" + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Outposts bucketAlias Ec2 Outpost Prod me-south-1", + "documentation": "Data Plane with medium zone (14 chars) fips with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "me-south-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3.ec2.s3-outposts.me-south-1.amazonaws.com" + "url": "https://myaccesspoint--test1-zone-ab1--xa-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "me-south-1", - "Bucket": "test-accessp-e0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Outposts bucketAlias Real Outpost Beta", + "documentation": "Data Plane with long zone (20 chars) fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3.op-0b1d075431d83bebd.example.amazonaws.com" + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", - "Endpoint": "https://example.amazonaws.com", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Outposts bucketAlias Ec2 Outpost Beta", + "documentation": "Data Plane with long zone (20 chars) fips with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4a", - "signingName": "s3-outposts", - "signingRegionSet": [ - "*" - ], - "disableDoubleEncoding": true - }, - { - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "us-east-1", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3.ec2.example.amazonaws.com" + "url": "https://myaccesspoint--test1-long1-zone-ab1--xa-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "us-east-1", - "Bucket": "161743052723-e00000136899934034jeahy1t8gpzpbwjj8kb7beta0--op-s3", - "Endpoint": "https://example.amazonaws.com", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false - } - }, - { - "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", - "expect": { - "error": "Expected a endpoint to be specified but no endpoint was found" - }, - "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-o0b1d075431d83bebde8xz5w8ijx1qzlbp3i3kbeta0--op-s3", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false - } - }, - { - "documentation": "S3 Outposts bucketAlias Invalid hardware type", - "expect": { - "error": "Unrecognized hardware type: \"Expected hardware type o or e but got h\"" - }, - "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-h0000075431d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false - } - }, - { - "documentation": "S3 Outposts bucketAlias Special character in Outpost Arn", - "expect": { - "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`." - }, - "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-o00000754%1d83bebde8xz5w8ijx1qzlbp3i3kuse10--op-s3", - "UseFIPS": false, - "UseDualStack": false, - "Accelerate": false - } - }, - { - "documentation": "S3 Outposts bucketAlias - No endpoint set for beta", - "expect": { - "error": "Expected a endpoint to be specified but no endpoint was found" - }, - "params": { - "Region": "us-east-1", - "Bucket": "test-accessp-e0b1d075431d83bebde8xz5w8ijx1qzlbp3i3ebeta0--op-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Snow with bucket", + "documentation": "Data Plane with long AZ", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "http://10.0.1.12:433/bucketName" + "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-az1--x-s3", + "Key": "key" + } + } + ], "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "http://10.0.1.12:433", + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Snow without bucket", + "documentation": "Data Plane with long AZ with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://10.0.1.12:433" + "url": "https://myaccesspoint--test1-az1--xa-s3.s3express-test1-az1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test1-az1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "snow", - "Endpoint": "https://10.0.1.12:433", + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-az1--xa-s3", "UseFIPS": false, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Snow no port", + "documentation": "Data Plane with long AZ fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "http://10.0.1.12/bucketName" + "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "mybucket--test1-az1--x-s3", + "Key": "key" + } + } + ], "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "http://10.0.1.12", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "S3 Snow dns endpoint", + "documentation": "Data Plane with long AZ fips with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4", - "signingName": "s3", - "signingRegion": "snow", + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } - ] + ], + "backend": "S3Express" }, - "url": "https://amazonaws.com/bucketName" + "url": "https://myaccesspoint--test1-az1--xa-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" } }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "AWS::UseFIPS": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test1-az1--xa-s3", + "Key": "key" + } + } + ], "params": { - "Region": "snow", - "Bucket": "bucketName", - "Endpoint": "https://amazonaws.com", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-az1--xa-s3", + "UseFIPS": true, "UseDualStack": false, - "Accelerate": false + "Accelerate": false, + "UseS3ExpressControlEndpoint": false } }, { - "documentation": "Data Plane with short zone name", + "documentation": "Control plane with short AZ bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true @@ -17277,7 +19506,7 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--abcd-ab1--x-s3.s3express-abcd-ab1.us-east-1.amazonaws.com" + "url": "https://s3express-control.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" } }, "operationInputs": [ @@ -17285,147 +19514,171 @@ "builtInParams": { "AWS::Region": "us-east-1" }, - "operationName": "GetObject", + "operationName": "CreateBucket", "operationParams": { - "Bucket": "mybucket--abcd-ab1--x-s3", - "Key": "key" + "Bucket": "mybucket--test-ab1--x-s3" } } ], "params": { "Region": "us-east-1", - "Bucket": "mybucket--abcd-ab1--x-s3", + "Bucket": "mybucket--test-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false } }, { - "documentation": "Data Plane with short zone names (13 chars)", + "documentation": "Control plane with short AZ bucket china region", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-west-2", + "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" + "url": "https://s3express-control.cn-north-1.amazonaws.com.cn/mybucket--test-ab1--x-s3" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "cn-north-1" }, - "operationName": "GetObject", + "operationName": "CreateBucket", "operationParams": { - "Bucket": "mybucket--test-zone-ab1--x-s3", - "Key": "key" + "Bucket": "mybucket--test-ab1--x-s3" } } ], "params": { - "Region": "us-west-2", - "Bucket": "mybucket--test-zone-ab1--x-s3", + "Region": "cn-north-1", + "Bucket": "mybucket--test-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false } }, { - "documentation": "Data Plane with medium zone names (14 chars)", + "documentation": "Control plane with short AZ bucket and fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-west-2", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://s3express-control-fips.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true }, - "operationName": "GetObject", + "operationName": "CreateBucket", "operationParams": { - "Bucket": "mybucket--test1-zone-ab1--x-s3", - "Key": "key" + "Bucket": "mybucket--test-ab1--x-s3" } } ], "params": { - "Region": "us-west-2", - "Bucket": "mybucket--test1-zone-ab1--x-s3", - "UseFIPS": false, + "Region": "us-east-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false } }, { - "documentation": "Data Plane with long zone names (20 chars)", + "documentation": "Control plane with short AZ bucket and fips china region", + "expect": { + "error": "Partition does not support FIPS" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": true + }, + "operationName": "CreateBucket", + "operationParams": { + "Bucket": "mybucket--test-ab1--x-s3" + } + } + ], + "params": { + "Region": "cn-north-1", + "Bucket": "mybucket--test-ab1--x-s3", + "UseFIPS": true, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false + } + }, + { + "documentation": "Control plane without bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-west-2", + "signingRegion": "us-east-1", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { - "AWS::Region": "us-west-2" + "AWS::Region": "us-east-1" }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", - "Key": "key" - } + "operationName": "ListDirectoryBuckets" } ], "params": { - "Region": "us-west-2", - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false } }, { - "documentation": "Data Plane with short zone fips", + "documentation": "Control plane without bucket and fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true @@ -17433,7 +19686,7 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test-ab1--x-s3.s3express-fips-test-ab1.us-east-1.amazonaws.com" + "url": "https://s3express-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ @@ -17442,30 +19695,26 @@ "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test-ab1--x-s3", - "Key": "key" - } + "operationName": "ListDirectoryBuckets" } ], "params": { "Region": "us-east-1", - "Bucket": "mybucket--test-ab1--x-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": false } }, { - "documentation": "Data Plane with short zone (13 chars) fips", + "documentation": "Data Plane sigv4 auth with short AZ", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true @@ -17473,39 +19722,80 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--usw2-az1--x-s3.s3express-usw2-az1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true + "params": { + "Region": "us-west-2", + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short AZ with AP", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://myaccesspoint--usw2-az1--xa-s3.s3express-usw2-az1.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "DisableS3ExpressSessionAuth": true + } + }, + { + "documentation": "Data Plane sigv4 auth with short zone (13 chars)", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test-zone-ab1--x-s3", - "Key": "key" - } + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" } - ], + }, "params": { "Region": "us-west-2", "Bucket": "mybucket--test-zone-ab1--x-s3", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane with medium zone (14 chars) fips", + "documentation": "Data Plane sigv4 auth with short zone (13 chars) with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true @@ -17513,39 +19803,26 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test-zone-ab1--xa-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test1-zone-ab1--x-s3", - "Key": "key" - } - } - ], "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-zone-ab1--x-s3", - "UseFIPS": true, + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane with long zone (20 chars) fips", + "documentation": "Data Plane sigv4 auth with short AZ fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true @@ -17553,39 +19830,26 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--usw2-az1--x-s3.s3express-fips-usw2-az1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", - "Key": "key" - } - } - ], "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", + "Bucket": "mybucket--usw2-az1--x-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane with long AZ", + "documentation": "Data Plane sigv4 auth with short AZ fips with AP", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true @@ -17593,38 +19857,26 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--usw2-az1--xa-s3.s3express-fips-usw2-az1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2" - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test1-az1--x-s3", - "Key": "key" - } - } - ], "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-az1--x-s3", - "UseFIPS": false, + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane with long AZ fips", + "documentation": "Data Plane sigv4 auth with short zone (13 chars) fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { - "name": "sigv4-s3express", + "name": "sigv4", "signingName": "s3express", "signingRegion": "us-west-2", "disableDoubleEncoding": true @@ -17632,33 +19884,20 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" + "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-west-2", - "AWS::UseFIPS": true - }, - "operationName": "GetObject", - "operationParams": { - "Bucket": "mybucket--test1-az1--x-s3", - "Key": "key" - } - } - ], "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-az1--x-s3", + "Bucket": "mybucket--test-zone-ab1--x-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Control plane with short AZ bucket", + "documentation": "Data Plane sigv4 auth with short zone (13 chars) fips with AP", "expect": { "endpoint": { "properties": { @@ -17666,38 +19905,26 @@ { "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://s3express-control.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" + "url": "https://myaccesspoint--test-zone-ab1--xa-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1" - }, - "operationName": "CreateBucket", - "operationParams": { - "Bucket": "mybucket--test-ab1--x-s3" - } - } - ], "params": { - "Region": "us-east-1", - "Bucket": "mybucket--test-ab1--x-s3", - "UseFIPS": false, + "Region": "us-west-2", + "Bucket": "myaccesspoint--test-zone-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": true, - "DisableS3ExpressSessionAuth": false + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Control plane with short AZ bucket and fips", + "documentation": "Data Plane sigv4 auth with long AZ", "expect": { "endpoint": { "properties": { @@ -17705,39 +19932,27 @@ { "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://s3express-control-fips.us-east-1.amazonaws.com/mybucket--test-ab1--x-s3" + "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseFIPS": true - }, - "operationName": "CreateBucket", - "operationParams": { - "Bucket": "mybucket--test-ab1--x-s3" - } - } - ], "params": { - "Region": "us-east-1", - "Bucket": "mybucket--test-ab1--x-s3", - "UseFIPS": true, + "Region": "us-west-2", + "Bucket": "mybucket--test1-az1--x-s3", + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": true, - "DisableS3ExpressSessionAuth": false + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Control plane without bucket", + "documentation": "Data Plane sigv4 auth with long AZ with AP", "expect": { "endpoint": { "properties": { @@ -17745,34 +19960,27 @@ { "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://s3express-control.us-east-1.amazonaws.com" + "url": "https://myaccesspoint--test1-az1--xa-s3.s3express-test1-az1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1" - }, - "operationName": "ListDirectoryBuckets" - } - ], "params": { - "Region": "us-east-1", + "Region": "us-west-2", + "Bucket": "myaccesspoint--test1-az1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": true, - "DisableS3ExpressSessionAuth": false + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Control plane without bucket and fips", + "documentation": "Data Plane sigv4 auth with medium zone(14 chars)", "expect": { "endpoint": { "properties": { @@ -17780,35 +19988,27 @@ { "name": "sigv4", "signingName": "s3express", - "signingRegion": "us-east-1", + "signingRegion": "us-west-2", "disableDoubleEncoding": true } ], "backend": "S3Express" }, - "url": "https://s3express-control-fips.us-east-1.amazonaws.com" + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" } }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1", - "AWS::UseFIPS": true - }, - "operationName": "ListDirectoryBuckets" - } - ], "params": { - "Region": "us-east-1", - "UseFIPS": true, + "Region": "us-west-2", + "Bucket": "mybucket--test1-zone-ab1--x-s3", + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": true, - "DisableS3ExpressSessionAuth": false + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane sigv4 auth with short AZ", + "documentation": "Data Plane sigv4 auth with medium zone(14 chars) with AP", "expect": { "endpoint": { "properties": { @@ -17822,20 +20022,21 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--usw2-az1--x-s3.s3express-usw2-az1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-zone-ab1--xa-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--usw2-az1--x-s3", + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, + "UseS3ExpressControlEndpoint": false, "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane sigv4 auth with short zone (13 chars)", + "documentation": "Data Plane sigv4 auth with long zone(20 chars)", "expect": { "endpoint": { "properties": { @@ -17849,20 +20050,21 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test-zone-ab1--x-s3.s3express-test-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test-zone-ab1--x-s3", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, + "UseS3ExpressControlEndpoint": false, "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane sigv4 auth with short AZ fips", + "documentation": "Data Plane sigv4 auth with long zone(20 chars) with AP", "expect": { "endpoint": { "properties": { @@ -17876,20 +20078,21 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--usw2-az1--x-s3.s3express-fips-usw2-az1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-long1-zone-ab1--xa-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--usw2-az1--x-s3", - "UseFIPS": true, + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, + "UseS3ExpressControlEndpoint": false, "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane sigv4 auth with short zone (13 chars) fips", + "documentation": "Data Plane sigv4 auth with long AZ fips", "expect": { "endpoint": { "properties": { @@ -17903,20 +20106,21 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test-zone-ab1--x-s3.s3express-fips-test-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test-zone-ab1--x-s3", + "Bucket": "mybucket--test1-az1--x-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, + "UseS3ExpressControlEndpoint": false, "DisableS3ExpressSessionAuth": true } }, { - "documentation": "Data Plane sigv4 auth with long AZ", + "documentation": "Data Plane sigv4 auth with long AZ fips with AP", "expect": { "endpoint": { "properties": { @@ -17930,13 +20134,13 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-az1--x-s3.s3express-test1-az1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-az1--xa-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-az1--x-s3", - "UseFIPS": false, + "Bucket": "myaccesspoint--test1-az1--xa-s3", + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, "UseS3ExpressControlEndpoint": false, @@ -17944,7 +20148,7 @@ } }, { - "documentation": "Data Plane sigv4 auth with medium zone(14 chars)", + "documentation": "Data Plane sigv4 auth with medium zone (14 chars) fips", "expect": { "endpoint": { "properties": { @@ -17958,13 +20162,13 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-test1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "Bucket": "mybucket--test1-zone-ab1--x-s3", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, "UseS3ExpressControlEndpoint": false, @@ -17972,7 +20176,7 @@ } }, { - "documentation": "Data Plane sigv4 auth with long zone(20 chars)", + "documentation": "Data Plane sigv4 auth with medium zone (14 chars) fips with AP", "expect": { "endpoint": { "properties": { @@ -17986,13 +20190,13 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-test1-long1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-zone-ab1--xa-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", - "UseFIPS": false, + "Bucket": "myaccesspoint--test1-zone-ab1--xa-s3", + "UseFIPS": true, "UseDualStack": false, "Accelerate": false, "UseS3ExpressControlEndpoint": false, @@ -18000,7 +20204,7 @@ } }, { - "documentation": "Data Plane sigv4 auth with long AZ fips", + "documentation": "Data Plane sigv4 auth with long zone (20 chars) fips", "expect": { "endpoint": { "properties": { @@ -18014,12 +20218,12 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-az1--x-s3.s3express-fips-test1-az1.us-west-2.amazonaws.com" + "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-az1--x-s3", + "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, @@ -18028,7 +20232,7 @@ } }, { - "documentation": "Data Plane sigv4 auth with medium zone (14 chars) fips", + "documentation": "Data Plane sigv4 auth with long zone (20 chars) fips with AP", "expect": { "endpoint": { "properties": { @@ -18042,12 +20246,12 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-zone-ab1--x-s3.s3express-fips-test1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://myaccesspoint--test1-long1-zone-ab1--xa-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-zone-ab1--x-s3", + "Bucket": "myaccesspoint--test1-long1-zone-ab1--xa-s3", "UseFIPS": true, "UseDualStack": false, "Accelerate": false, @@ -18056,7 +20260,7 @@ } }, { - "documentation": "Data Plane sigv4 auth with long zone (20 chars) fips", + "documentation": "Control Plane host override", "expect": { "endpoint": { "properties": { @@ -18070,21 +20274,22 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--test1-long1-zone-ab1--x-s3.s3express-fips-test1-long1-zone-ab1.us-west-2.amazonaws.com" + "url": "https://mybucket--usw2-az1--x-s3.custom.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--test1-long1-zone-ab1--x-s3", - "UseFIPS": true, + "Bucket": "mybucket--usw2-az1--x-s3", + "UseFIPS": false, "UseDualStack": false, "Accelerate": false, - "UseS3ExpressControlEndpoint": false, - "DisableS3ExpressSessionAuth": true + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://custom.com" } }, { - "documentation": "Control Plane host override", + "documentation": "Control Plane host override with AP", "expect": { "endpoint": { "properties": { @@ -18098,12 +20303,12 @@ ], "backend": "S3Express" }, - "url": "https://mybucket--usw2-az1--x-s3.custom.com" + "url": "https://myaccesspoint--usw2-az1--xa-s3.custom.com" } }, "params": { "Region": "us-west-2", - "Bucket": "mybucket--usw2-az1--x-s3", + "Bucket": "myaccesspoint--usw2-az1--xa-s3", "UseFIPS": false, "UseDualStack": false, "Accelerate": false, @@ -18180,6 +20385,46 @@ "Endpoint": "https://10.0.0.1" } }, + { + "documentation": "Data plane host override non virtual session auth with AP", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/myaccesspoint--usw2-az1--xa-s3" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://10.0.0.1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://10.0.0.1" + } + }, { "documentation": "Control Plane host override ip", "expect": { @@ -18209,6 +20454,35 @@ "Endpoint": "https://10.0.0.1" } }, + { + "documentation": "Control Plane host override ip with AP", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://10.0.0.1/myaccesspoint--usw2-az1--xa-s3" + } + }, + "params": { + "Region": "us-west-2", + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": true, + "DisableS3ExpressSessionAuth": true, + "Endpoint": "https://10.0.0.1" + } + }, { "documentation": "Data plane host override", "expect": { @@ -18249,6 +20523,46 @@ "Endpoint": "https://custom.com" } }, + { + "documentation": "Data plane host override with AP", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4-s3express", + "signingName": "s3express", + "signingRegion": "us-west-2", + "disableDoubleEncoding": true + } + ], + "backend": "S3Express" + }, + "url": "https://myaccesspoint--usw2-az1--xa-s3.custom.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, { "documentation": "bad format error", "expect": { @@ -18275,6 +20589,32 @@ "UseS3ExpressControlEndpoint": false } }, + { + "documentation": "bad AP format error", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--usaz1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "myaccesspoint--usaz1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, { "documentation": "bad format error no session auth", "expect": { @@ -18302,6 +20642,33 @@ "DisableS3ExpressSessionAuth": true } }, + { + "documentation": "bad AP format error no session auth", + "expect": { + "error": "Unrecognized S3Express bucket name format." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--usaz1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "myaccesspoint--usaz1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false, + "DisableS3ExpressSessionAuth": true + } + }, { "documentation": "dual-stack error", "expect": { @@ -18329,6 +20696,33 @@ "UseS3ExpressControlEndpoint": false } }, + { + "documentation": "dual-stack error with AP", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "UseFIPS": false, + "UseDualStack": true, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, { "documentation": "accelerate error", "expect": { @@ -18356,6 +20750,33 @@ "UseS3ExpressControlEndpoint": false } }, + { + "documentation": "accelerate error with AP", + "expect": { + "error": "S3Express does not support S3 Accelerate." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::S3::Accelerate": true + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "myaccesspoint--test-ab1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": true, + "UseS3ExpressControlEndpoint": false + } + }, { "documentation": "Data plane bucket format error", "expect": { @@ -18382,6 +20803,32 @@ "UseS3ExpressControlEndpoint": false } }, + { + "documentation": "Data plane AP format error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.myaccesspoint--test-ab1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-east-1", + "Bucket": "my.myaccesspoint--test-ab1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "UseS3ExpressControlEndpoint": false + } + }, { "documentation": "host override data plane bucket error session auth", "expect": { @@ -18409,6 +20856,33 @@ "Endpoint": "https://custom.com" } }, + { + "documentation": "host override data plane AP error session auth", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-west-2", + "SDK::Endpoint": "https://custom.com" + }, + "operationName": "GetObject", + "operationParams": { + "Bucket": "my.myaccesspoint--usw2-az1--xa-s3", + "Key": "key" + } + } + ], + "params": { + "Region": "us-west-2", + "Bucket": "my.myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com" + } + }, { "documentation": "host override data plane bucket error", "expect": { @@ -18423,6 +20897,21 @@ "Endpoint": "https://custom.com", "DisableS3ExpressSessionAuth": true } + }, + { + "documentation": "host override data plane AP error", + "expect": { + "error": "S3Express bucket name is not a valid virtual hostable name." + }, + "params": { + "Region": "us-west-2", + "Bucket": "my.myaccesspoint--usw2-az1--xa-s3", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "Endpoint": "https://custom.com", + "DisableS3ExpressSessionAuth": true + } } ], "version": "1.0" @@ -19503,7 +21992,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -19927,7 +22416,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the destination bucket.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must use the Outpost bucket access point ARN or the access point alias for the destination bucket. \n \n You can only copy objects within the same Outpost bucket. It's not supported to copy objects across different Amazon Web Services Outposts, between buckets on the same Outposts, or between Outposts buckets and any other bucket types. \n For more information about S3 on Outposts, see What is S3 on Outposts? in the S3 on Outposts guide. \n When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname, in the format \n \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.\n

", + "smithy.api#documentation": "

The name of the destination bucket.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must use the Outpost bucket access point ARN or the access point alias for the destination bucket. \n \n You can only copy objects within the same Outpost bucket. It's not supported to copy objects across different Amazon Web Services Outposts, between buckets on the same Outposts, or between Outposts buckets and any other bucket types. \n For more information about S3 on Outposts, see What is S3 on Outposts? in the S3 on Outposts guide. \n When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname, in the format \n \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -20093,7 +22582,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

If the x-amz-storage-class header is not used, the copied object will be\n stored in the STANDARD Storage Class by default. The STANDARD\n storage class provides high durability and high availability. Depending on performance\n needs, you can specify a different Storage Class.

\n \n
    \n
  • \n

    \n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

    \n
    • \n
  • \n

    \n Amazon S3 on Outposts - S3 on Outposts only\n uses the OUTPOSTS Storage Class.

    \n
    • \n
\n \n

You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 by using the x-amz-storage-class header. For\n more information, see Storage Classes in the\n Amazon S3 User Guide.

\n

Before using an object as a source object for the copy operation, you must restore a\n copy of it if it meets any of the following conditions:

\n
    \n
  • \n

    The storage class of the source object is GLACIER or\n DEEP_ARCHIVE.

    \n
    • \n
  • \n

    The storage class of the source object is INTELLIGENT_TIERING and\n it's S3 Intelligent-Tiering access tier is Archive Access or\n Deep Archive Access.

    \n
    • \n
\n

For more information, see RestoreObject and Copying\n Objects in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

If the x-amz-storage-class header is not used, the copied object will be\n stored in the STANDARD Storage Class by default. The STANDARD\n storage class provides high durability and high availability. Depending on performance\n needs, you can specify a different Storage Class.

\n \n
    \n
  • \n

    \n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

    \n
    • \n
  • \n

    \n Amazon S3 on Outposts - S3 on Outposts only\n uses the OUTPOSTS Storage Class.

    \n
    • \n
\n \n

You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 by using the x-amz-storage-class header. For\n more information, see Storage Classes in the\n Amazon S3 User Guide.

\n

Before using an object as a source object for the copy operation, you must restore a\n copy of it if it meets any of the following conditions:

\n
    \n
  • \n

    The storage class of the source object is GLACIER or\n DEEP_ARCHIVE.

    \n
    • \n
  • \n

    The storage class of the source object is INTELLIGENT_TIERING and\n it's S3 Intelligent-Tiering access tier is Archive Access or\n Deep Archive Access.

    \n
    • \n
\n

For more information, see RestoreObject and Copying\n Objects in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -20767,7 +23256,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket where the multipart upload is initiated and where the object is\n uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket where the multipart upload is initiated and where the object is\n uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -20873,7 +23362,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    For directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -22104,7 +24593,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22246,7 +24735,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22404,7 +24893,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -24182,7 +26671,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to get the bucket policy for.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

\n

\n Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n ", + "smithy.api#documentation": "

The bucket name to get the bucket policy for.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide\n

\n

\n Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Object Lambda access points are not supported by directory buckets.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -24719,7 +27208,7 @@ "SHA1" ] }, - "smithy.api#documentation": "

Retrieves an object from Amazon S3.

\n

In the GetObject request, specify the full key name for the object.

\n

\n General purpose buckets - Both the virtual-hosted-style\n requests and the path-style requests are supported. For a virtual hosted-style request\n example, if you have the object photos/2006/February/sample.jpg, specify the\n object key name as /photos/2006/February/sample.jpg. For a path-style request\n example, if you have the object photos/2006/February/sample.jpg in the bucket\n named examplebucket, specify the object key name as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification in the Amazon S3 User Guide.

\n

\n Directory buckets -\n Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have the required permissions in a policy. To use\n GetObject, you must have the READ access to the\n object (or version). If you grant READ access to the anonymous\n user, the GetObject operation returns the object without using\n an authorization header. For more information, see Specifying permissions in a policy in the\n Amazon S3 User Guide.

    \n

    If you include a versionId in your request header, you must\n have the s3:GetObjectVersion permission to access a specific\n version of an object. The s3:GetObject permission is not\n required in this scenario.

    \n

    If you request the current version of an object without a specific\n versionId in the request header, only the\n s3:GetObject permission is required. The\n s3:GetObjectVersion permission is not required in this\n scenario.

    \n

    If the object that you request doesn\u2019t exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket\n permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found\n error.

      \n
      • \n
    • \n

      If you don\u2019t have the s3:ListBucket permission, Amazon S3\n returns an HTTP status code 403 Access Denied\n error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If\n the\n object is encrypted using SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Storage classes
\n
\n

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval\n storage class, the S3 Glacier Deep Archive storage class, the\n S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,\n before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState error. For information about restoring archived\n objects, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

\n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

\n
\n
Encryption
\n
\n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for the GetObject requests, if your object uses\n server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your\n GetObject requests for the object that uses these types of keys,\n you\u2019ll get an HTTP 400 Bad Request error.

\n

\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n
\n
Overriding response header values through the request
\n
\n

There are times when you want to override certain response header values of a\n GetObject response. For example, you might override the\n Content-Disposition response header value through your\n GetObject request.

\n

You can override values for a set of response headers. These modified response\n header values are included only in a successful response, that is, when the HTTP\n status code 200 OK is returned. The headers you can override using\n the following query parameters in the request are a subset of the headers that\n Amazon S3 accepts when you create an object.

\n

The response headers that you can override for the GetObject\n response are Cache-Control, Content-Disposition,\n Content-Encoding, Content-Language,\n Content-Type, and Expires.

\n

To override values for a set of response headers in the GetObject\n response, you can use the following query parameters in the request.

\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 response-content-language\n

    \n
    • \n
  • \n

    \n response-content-type\n

    \n
    • \n
  • \n

    \n response-expires\n

    \n
    • \n
\n \n

When you use these parameters, you must sign the request by using either an\n Authorization header or a presigned URL. These parameters cannot be used with\n an unsigned (anonymous) request.

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to GetObject:

\n ", + "smithy.api#documentation": "

Retrieves an object from Amazon S3.

\n

In the GetObject request, specify the full key name for the object.

\n

\n General purpose buckets - Both the virtual-hosted-style\n requests and the path-style requests are supported. For a virtual hosted-style request\n example, if you have the object photos/2006/February/sample.jpg, specify the\n object key name as /photos/2006/February/sample.jpg. For a path-style request\n example, if you have the object photos/2006/February/sample.jpg in the bucket\n named examplebucket, specify the object key name as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification in the Amazon S3 User Guide.

\n

\n Directory buckets -\n Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name\n . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the\n Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the\n Amazon S3 User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - You\n must have the required permissions in a policy. To use\n GetObject, you must have the READ access to the\n object (or version). If you grant READ access to the anonymous\n user, the GetObject operation returns the object without using\n an authorization header. For more information, see Specifying permissions in a policy in the\n Amazon S3 User Guide.

    \n

    If you include a versionId in your request header, you must\n have the s3:GetObjectVersion permission to access a specific\n version of an object. The s3:GetObject permission is not\n required in this scenario.

    \n

    If you request the current version of an object without a specific\n versionId in the request header, only the\n s3:GetObject permission is required. The\n s3:GetObjectVersion permission is not required in this\n scenario.

    \n

    If the object that you request doesn\u2019t exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket\n permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found\n error.

      \n
      • \n
    • \n

      If you don\u2019t have the s3:ListBucket permission, Amazon S3\n returns an HTTP status code 403 Access Denied\n error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If\n the\n object is encrypted using SSE-KMS, you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.

    \n
    • \n
\n
\n
Storage classes
\n
\n

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval\n storage class, the S3 Glacier Deep Archive storage class, the\n S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,\n before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState error. For information about restoring archived\n objects, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

\n
\n
Encryption
\n
\n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for the GetObject requests, if your object uses\n server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your\n GetObject requests for the object that uses these types of keys,\n you\u2019ll get an HTTP 400 Bad Request error.

\n

\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n
\n
Overriding response header values through the request
\n
\n

There are times when you want to override certain response header values of a\n GetObject response. For example, you might override the\n Content-Disposition response header value through your\n GetObject request.

\n

You can override values for a set of response headers. These modified response\n header values are included only in a successful response, that is, when the HTTP\n status code 200 OK is returned. The headers you can override using\n the following query parameters in the request are a subset of the headers that\n Amazon S3 accepts when you create an object.

\n

The response headers that you can override for the GetObject\n response are Cache-Control, Content-Disposition,\n Content-Encoding, Content-Language,\n Content-Type, and Expires.

\n

To override values for a set of response headers in the GetObject\n response, you can use the following query parameters in the request.

\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 response-content-language\n

    \n
    • \n
  • \n

    \n response-content-type\n

    \n
    • \n
  • \n

    \n response-expires\n

    \n
    • \n
\n \n

When you use these parameters, you must sign the request by using either an\n Authorization header or a presigned URL. These parameters cannot be used with\n an unsigned (anonymous) request.

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket-name.s3express-zone-id.region-code.amazonaws.com.

\n
\n
\n

The following operations are related to GetObject:

\n ", "smithy.api#examples": [ { "title": "To retrieve a byte range of an object ", @@ -24872,7 +27361,7 @@ "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

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -24989,7 +27478,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } }, "ObjectSize": { @@ -25057,7 +27546,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -25180,7 +27669,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose legal hold status you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object whose legal hold status you want to retrieve.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -25259,7 +27748,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -25314,7 +27803,7 @@ "Restore": { "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "

Provides information about object restoration action and expiration time of the restored\n object copy.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#documentation": "

Provides information about object restoration action and expiration time of the restored\n object copy.

\n \n

This functionality is not supported for directory buckets.\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n ", "smithy.api#httpHeader": "x-amz-restore" } }, @@ -25496,7 +27985,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n ", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -25559,7 +28048,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -25757,7 +28246,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -25885,7 +28374,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -26286,7 +28775,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -26404,7 +28893,7 @@ "Restore": { "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "

If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

\n

If an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:

\n

\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00\n GMT\"\n

\n

If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\".

\n

For more information about archiving objects, see Transitioning Objects: General Considerations.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#documentation": "

If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

\n

If an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:

\n

\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00\n GMT\"\n

\n

If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\".

\n

For more information about archiving objects, see Transitioning Objects: General Considerations.

\n \n

This functionality is not supported for directory buckets.\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n ", "smithy.api#httpHeader": "x-amz-restore" } }, @@ -26593,7 +29082,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n ", + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n

For more information, see Storage Classes.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n ", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -26649,7 +29138,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -28431,7 +30920,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -28881,7 +31370,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29108,7 +31597,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29335,7 +31824,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

The class of storage used to store the uploaded object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

The class of storage used to store the uploaded object.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } }, "RequestCharged": { @@ -29368,7 +31857,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29847,7 +32336,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } }, "Owner": { @@ -30094,7 +32583,7 @@ "StorageClass": { "target": "com.amazonaws.s3#ObjectStorageClass", "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

The class of storage used to store the object.

\n \n

\n Directory buckets -\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } }, "Owner": { @@ -30106,7 +32595,7 @@ "RestoreStatus": { "target": "com.amazonaws.s3#RestoreStatus", "traits": { - "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } } }, @@ -32867,7 +35356,7 @@ "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

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -33001,7 +35490,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object that you want to place a legal hold on.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object that you want to place a legal hold on.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -33307,7 +35796,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -33490,7 +35979,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    For directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

    \n
    • \n
  • \n

    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    \n
    • \n
\n ", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -33630,7 +36119,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -33767,7 +36256,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -33984,7 +36473,7 @@ "Payload": { "target": "com.amazonaws.s3#Body", "traits": { - "smithy.api#documentation": "

The byte array of partial, one or more result records. S3 Select doesn't guarantee that\n a record will be self-contained in one record frame. To ensure continuous streaming of\n data, S3 Select might split the same record across multiple record frames instead of\n aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by\n default. Other clients might not handle this behavior by default. In those cases, you must\n aggregate the results on the client side and parse the response.

", + "smithy.api#documentation": "

The byte array of partial, one or more result records. S3 Select doesn't guarantee that\n a record will be self-contained in one record frame. To ensure continuous streaming of\n data, S3 Select might split the same record across multiple record frames instead of\n aggregating the results in memory. Some S3 clients (for example, the SDKforJava) handle this behavior by creating a ByteStream out of the response by\n default. Other clients might not handle this behavior by default. In those cases, you must\n aggregate the results on the client side and parse the response.

", "smithy.api#eventPayload": {} } } @@ -34451,7 +36940,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Restores an archived copy of an object back into Amazon S3

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

For more information about the S3 structure in the request body, see the\n following:

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by\n 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 Resources in the\n Amazon S3 User Guide.

\n
\n
Restoring objects
\n
\n

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.

\n

To restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data\n access tier options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1\u20135 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n Standard - Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3\u20135 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5\u201312 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity\n for Expedited data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD\n request. Operations return the x-amz-restore header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in\n the response.

    \n
    • \n
\n
    \n
  • \n

    Special errors:

    \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress.\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: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not 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

The following operations are related to RestoreObject:

\n ", + "smithy.api#documentation": "\n

This operation is not supported for directory buckets.

\n \n

Restores an archived copy of an object back into Amazon S3

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

For more information about the S3 structure in the request body, see the\n following:

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by\n 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 Resources in the\n Amazon S3 User Guide.

\n
\n
Restoring objects
\n
\n

Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.

\n

To restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data\n access tier options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1\u20135 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n Standard - Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3\u20135 hours for objects stored in the\n S3 Glacier Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5\u201312 hours for objects stored in the\n S3 Glacier Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity\n for Expedited data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD\n request. Operations return the x-amz-restore header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in\n the response.

    \n
    • \n
\n
    \n
  • \n

    Special errors:

    \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress.\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: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not 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

The following operations are related to RestoreObject:

\n ", "smithy.api#examples": [ { "title": "To restore an archived object", @@ -34503,7 +36992,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -34639,7 +37128,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

\n " + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.

\n \n

This functionality is not supported for directory buckets.\n Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

\n " } }, "com.amazonaws.s3#Role": { @@ -35998,7 +38487,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name.

\n

\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n \n

Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

\n \n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -36245,7 +38734,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Access points and Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format \n bucket-base-name--zone-id--x-s3 (for example, \n amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.

\n

\n Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

\n \n

Object Lambda access points are not supported by directory buckets.

\n \n

\n S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the \n form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { diff --git a/s3tables/service/2018-05-10/s3tables-2018-05-10.json b/s3tables/service/2018-05-10/s3tables-2018-05-10.json index c789993c..147feb73 100644 --- a/s3tables/service/2018-05-10/s3tables-2018-05-10.json +++ b/s3tables/service/2018-05-10/s3tables-2018-05-10.json @@ -165,7 +165,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide.

\n
\n
Permissions
\n
\n

You must have the s3tables:CreateTable permission to use this operation.

\n \n

Additionally, you must have the s3tables:PutTableData permission to use this operation with the optional metadata request parameter.

\n \n
\n
", + "smithy.api#documentation": "

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    You must have the s3tables:CreateTable permission to use this operation.

    \n
    • \n
  • \n

    If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.

    \n
    • \n
  • \n

    If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PutTableEncryption permission.

    \n
    • \n
\n \n

Additionally,

\n \n
\n
", "smithy.api#http": { "uri": "/tables/{tableBucketARN}/{namespace}", "method": "PUT", @@ -202,7 +202,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.

\n
\n
Permissions
\n
\n

You must have the s3tables:CreateTableBucket permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.

\n
\n
Permissions
\n
\n
    \n
  • \n

    You must have the s3tables:CreateTableBucket permission to use this operation.

    \n
    • \n
  • \n

    If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.

    \n
    • \n
\n
\n
", "smithy.api#http": { "uri": "/buckets", "method": "PUT", @@ -219,6 +219,12 @@ "smithy.api#documentation": "

The name for the table bucket.

", "smithy.api#required": {} } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.s3tables#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.

" + } } }, "traits": { @@ -278,6 +284,12 @@ "traits": { "smithy.api#documentation": "

The metadata for the table.

" } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.s3tables#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.

\n \n

If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

\n " + } } }, "traits": { @@ -444,6 +456,60 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.s3tables#DeleteTableBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#DeleteTableBucketEncryptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the encryption configuration for a table bucket.

\n
\n
Permissions
\n
\n

You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.

\n
\n
", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/encryption", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#DeleteTableBucketEncryptionRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3tables#DeleteTableBucketPolicy": { "type": "operation", "input": { @@ -623,6 +689,32 @@ "smithy.api#input": {} } }, + "com.amazonaws.s3tables#EncryptionConfiguration": { + "type": "structure", + "members": { + "sseAlgorithm": { + "target": "com.amazonaws.s3tables#SSEAlgorithm", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)$" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

" + } + }, "com.amazonaws.s3tables#ErrorMessage": { "type": "string" }, @@ -752,6 +844,18 @@ "smithy.api#documentation": "

The ID of the account that owns the namespcace.

", "smithy.api#required": {} } + }, + "namespaceId": { + "target": "com.amazonaws.s3tables#NamespaceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the namespace.

" + } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the table bucket containing this namespace.

" + } } }, "traits": { @@ -874,6 +978,74 @@ ] } }, + "com.amazonaws.s3tables#GetTableBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableBucketEncryptionRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableBucketEncryptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the encryption configuration for a table bucket.

\n
\n
Permissions
\n
\n

You must have the s3tables:GetTableBucketEncryption permission to use this operation.

\n
\n
", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/encryption", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketEncryptionRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableBucketEncryptionResponse": { + "type": "structure", + "members": { + "encryptionConfiguration": { + "target": "com.amazonaws.s3tables#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3tables#GetTableBucketMaintenanceConfiguration": { "type": "operation", "input": { @@ -1064,6 +1236,96 @@ "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the table bucket.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3tables#GetTableEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#GetTableEncryptionRequest" + }, + "output": { + "target": "com.amazonaws.s3tables#GetTableEncryptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the encryption configuration for a table.

\n
\n
Permissions
\n
\n

You must have the s3tables:GetTableEncryption permission to use this operation.

\n
\n
", + "smithy.api#http": { + "uri": "/tables/{tableBucketARN}/{namespace}/{name}/encryption", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.s3tables#GetTableEncryptionRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket containing the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.s3tables#NamespaceName", + "traits": { + "smithy.api#documentation": "

The namespace associated with the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.s3tables#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3tables#GetTableEncryptionResponse": { + "type": "structure", + "members": { + "encryptionConfiguration": { + "target": "com.amazonaws.s3tables#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration for the table.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1496,6 +1758,13 @@ "smithy.api#required": {} } }, + "namespaceId": { + "target": "com.amazonaws.s3tables#NamespaceId", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The unique identifier of the namespace containing this table.

" + } + }, "versionToken": { "target": "com.amazonaws.s3tables#VersionToken", "traits": { @@ -1565,6 +1834,12 @@ "smithy.api#documentation": "

The format of the table.

", "smithy.api#required": {} } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the table bucket containing this table.

" + } } }, "traits": { @@ -1582,7 +1857,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about the compaction settings for an Iceberg table. \n

" + "smithy.api#documentation": "

Contains details about the compaction settings for an Iceberg table.

" } }, "com.amazonaws.s3tables#IcebergMetadata": { @@ -1632,7 +1907,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the maxSnapshotAgeHours and the total number of snapshots exceeds the value for the minimum number of snapshots to keep minSnapshotsToKeep.\n

" + "smithy.api#documentation": "

Contains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the maxSnapshotAgeHours and the total number of snapshots exceeds the value for the minimum number of snapshots to keep minSnapshotsToKeep.

" } }, "com.amazonaws.s3tables#IcebergUnreferencedFileRemovalSettings": { @@ -1641,18 +1916,18 @@ "unreferencedDays": { "target": "com.amazonaws.s3tables#PositiveInteger", "traits": { - "smithy.api#documentation": "

The number of days an object has to be unreferenced before it is marked as non-current.\n\n

" + "smithy.api#documentation": "

The number of days an object has to be unreferenced before it is marked as non-current.

" } }, "nonCurrentDays": { "target": "com.amazonaws.s3tables#PositiveInteger", "traits": { - "smithy.api#documentation": "

The number of days an object has to be non-current before it is deleted.\n \n

" + "smithy.api#documentation": "

The number of days an object has to be non-current before it is deleted.

" } } }, "traits": { - "smithy.api#documentation": "

Contains details about the unreferenced file removal settings for an Iceberg table bucket. \n

" + "smithy.api#documentation": "

Contains details about the unreferenced file removal settings for an Iceberg table bucket.

" } }, "com.amazonaws.s3tables#InternalServerErrorException": { @@ -2117,6 +2392,9 @@ } } }, + "com.amazonaws.s3tables#NamespaceId": { + "type": "string" + }, "com.amazonaws.s3tables#NamespaceList": { "type": "list", "member": { @@ -2181,6 +2459,18 @@ "smithy.api#documentation": "

The ID of the account that owns the namespace.

", "smithy.api#required": {} } + }, + "namespaceId": { + "target": "com.amazonaws.s3tables#NamespaceId", + "traits": { + "smithy.api#documentation": "

The system-assigned unique identifier for the namespace.

" + } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The system-assigned unique identifier for the table bucket that contains this namespace.

" + } } }, "traits": { @@ -2235,6 +2525,67 @@ } } }, + "com.amazonaws.s3tables#PutTableBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3tables#PutTableBucketEncryptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.s3tables#BadRequestException" + }, + { + "target": "com.amazonaws.s3tables#ConflictException" + }, + { + "target": "com.amazonaws.s3tables#ForbiddenException" + }, + { + "target": "com.amazonaws.s3tables#InternalServerErrorException" + }, + { + "target": "com.amazonaws.s3tables#NotFoundException" + }, + { + "target": "com.amazonaws.s3tables#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the encryption configuration for a table bucket.

\n
\n
Permissions
\n
\n

You must have the s3tables:PutTableBucketEncryption permission to use this operation.

\n \n

If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption\n

\n \n
\n
", + "smithy.api#http": { + "uri": "/buckets/{tableBucketARN}/encryption", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.s3tables#PutTableBucketEncryptionRequest": { + "type": "structure", + "members": { + "tableBucketARN": { + "target": "com.amazonaws.s3tables#TableBucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.s3tables#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration to apply to the table bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3tables#PutTableBucketMaintenanceConfiguration": { "type": "operation", "input": { @@ -2628,12 +2979,18 @@ { "target": "com.amazonaws.s3tables#NamespaceResource" }, + { + "target": "com.amazonaws.s3tables#TableBucketEncryptionResource" + }, { "target": "com.amazonaws.s3tables#TableBucketPolicyResource" }, { "target": "com.amazonaws.s3tables#TableBucketResource" }, + { + "target": "com.amazonaws.s3tables#TableEncryptionResource" + }, { "target": "com.amazonaws.s3tables#TablePolicyResource" }, @@ -2652,7 +3009,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the AWS Glue Data Catalog you can interact with your tables using AWS analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.

", + "smithy.api#documentation": "

An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the Amazon Web Services Glue Data Catalog you can interact with your tables using Amazon Web Services analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.

", "smithy.api#title": "Amazon S3 Tables", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3320,6 +3677,23 @@ } } }, + "com.amazonaws.s3tables#SSEAlgorithm": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "AWS_KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws:kms" + } + } + } + }, "com.amazonaws.s3tables#SchemaField": { "type": "structure", "members": { @@ -3377,6 +3751,29 @@ "smithy.api#pattern": "^(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})$" } }, + "com.amazonaws.s3tables#TableBucketEncryptionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#DeleteTableBucketEncryption" + }, + { + "target": "com.amazonaws.s3tables#GetTableBucketEncryption" + }, + { + "target": "com.amazonaws.s3tables#PutTableBucketEncryption" + } + ], + "traits": { + "aws.api#arn": { + "absolute": true, + "template": "com.amazonaws.s3tables#TableBucketARN" + } + } + }, + "com.amazonaws.s3tables#TableBucketId": { + "type": "string" + }, "com.amazonaws.s3tables#TableBucketMaintenanceConfiguration": { "type": "map", "key": { @@ -3515,6 +3912,12 @@ "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The system-assigned unique identifier for the table bucket.

" + } } }, "traits": { @@ -3527,6 +3930,20 @@ "target": "com.amazonaws.s3tables#TableBucketSummary" } }, + "com.amazonaws.s3tables#TableEncryptionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.s3tables#GetTableEncryption" + } + ], + "traits": { + "aws.api#arn": { + "absolute": true, + "template": "com.amazonaws.s3tables#TableARN" + } + } + }, "com.amazonaws.s3tables#TableMaintenanceConfiguration": { "type": "map", "key": { @@ -3778,6 +4195,18 @@ "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } + }, + "namespaceId": { + "target": "com.amazonaws.s3tables#NamespaceId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the namespace that contains this table.

" + } + }, + "tableBucketId": { + "target": "com.amazonaws.s3tables#TableBucketId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the table bucket that contains this table.

" + } } }, "traits": { diff --git a/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json b/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json index fd966e55..2289d1f7 100644 --- a/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json +++ b/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json @@ -7715,6 +7715,156 @@ "traits": { "smithy.api#enumValue": "ml.r6i.32xlarge" } + }, + "ML_I3EN_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.large" + } + }, + "ML_I3EN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.xlarge" + } + }, + "ML_I3EN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.2xlarge" + } + }, + "ML_I3EN_3XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.3xlarge" + } + }, + "ML_I3EN_6XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.6xlarge" + } + }, + "ML_I3EN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.12xlarge" + } + }, + "ML_I3EN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.i3en.24xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } } } }, @@ -13747,6 +13897,12 @@ "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.

" } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

" + } } }, "traits": { @@ -49783,6 +49939,9 @@ "traits": { "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" } + }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle" } }, "traits": { @@ -56155,7 +56314,7 @@ "InferenceAmiVersion": { "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", "traits": { - "smithy.api#documentation": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.

\n

By selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.

\n

The AMI version names, and their configurations, are the following:

\n
\n
al2-ami-sagemaker-inference-gpu-2
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 535

    \n
    • \n
  • \n

    CUDA version: 12.2

    \n
    • \n
\n
\n
al2-ami-sagemaker-inference-gpu-2-1
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 535

    \n
    • \n
  • \n

    CUDA version: 12.2

    \n
    • \n
  • \n

    NVIDIA Container Toolkit with disabled CUDA-compat mounting

    \n
    • \n
\n
\n
al2-ami-sagemaker-inference-gpu-3-1
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 550

    \n
    • \n
  • \n

    CUDA version: 12.4

    \n
    • \n
  • \n

    NVIDIA Container Toolkit with disabled CUDA-compat mounting

    \n
    • \n
\n
\n
" + "smithy.api#documentation": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.

\n

By selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.

\n

The AMI version names, and their configurations, are the following:

\n
\n
al2-ami-sagemaker-inference-gpu-2
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 535

    \n
    • \n
  • \n

    CUDA version: 12.2

    \n
    • \n
\n
\n
al2-ami-sagemaker-inference-gpu-2-1
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 535

    \n
    • \n
  • \n

    CUDA version: 12.2

    \n
    • \n
  • \n

    NVIDIA Container Toolkit with disabled CUDA-compat mounting

    \n
    • \n
\n
\n
al2-ami-sagemaker-inference-gpu-3-1
\n
\n
    \n
  • \n

    Accelerator: GPU

    \n
    • \n
  • \n

    NVIDIA driver version: 550

    \n
    • \n
  • \n

    CUDA version: 12.4

    \n
    • \n
  • \n

    NVIDIA Container Toolkit with disabled CUDA-compat mounting

    \n
    • \n
\n
\n
al2-ami-sagemaker-inference-neuron-2
\n
\n
    \n
  • \n

    Accelerator: Inferentia2 and Trainium

    \n
    • \n
  • \n

    Neuron driver version: 2.19

    \n
    • \n
\n
\n
" } } }, @@ -56255,6 +56414,12 @@ "traits": { "smithy.api#enumValue": "al2-ami-sagemaker-inference-gpu-3-1" } + }, + "AL2_NEURON_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "al2-ami-sagemaker-inference-neuron-2" + } } } }, @@ -66772,7 +66937,7 @@ "MaxPendingTimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxPendingTimeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.

\n \n

When working with training jobs that use capacity from training\n plans, not all Pending job states count against the\n MaxPendingTimeInSeconds limit. The following scenarios do not\n increment the MaxPendingTimeInSeconds counter:

\n
    \n
  • \n

    The plan is in a Scheduled state: Jobs queued (in\n Pending status) before a plan's start date (waiting for\n scheduled start time)

    \n
    • \n
  • \n

    Between capacity reservations: Jobs temporarily back to\n Pending status between two capacity reservation\n periods

    \n
    • \n
\n

\n MaxPendingTimeInSeconds only increments when jobs are actively\n waiting for capacity in an Active plan.

\n " } } }, diff --git a/securityhub/service/2018-10-26/securityhub-2018-10-26.json b/securityhub/service/2018-10-26/securityhub-2018-10-26.json index 3a637050..b4054089 100644 --- a/securityhub/service/2018-10-26/securityhub-2018-10-26.json +++ b/securityhub/service/2018-10-26/securityhub-2018-10-26.json @@ -26108,7 +26108,7 @@ "AssociationType": "INHERITED", "UpdatedAt": "2023-01-11T06:17:17.154Z", "AssociationStatus": "FAILED", - "AssociationStatusMessage": "Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn\u2019t be applied to account 111122223333 in us-east-1 Region. Retry your request." + "AssociationStatusMessage": "Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn't be applied to account 111122223333 in us-east-1 Region. Retry your request." } } ], @@ -33847,7 +33847,7 @@ "StandardsArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of a standard.

" + "smithy.api#documentation": "

The ARN of the standard.

" } }, "Name": { @@ -34291,7 +34291,7 @@ } }, "traits": { - "smithy.api#documentation": "

The reason for the current status of a standard subscription.

" + "smithy.api#documentation": "

The reason for the current status of your subscription to the standard.

" } }, "com.amazonaws.securityhub#StandardsSubscription": { @@ -34301,7 +34301,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of a resource that represents your subscription to a supported standard.

", + "smithy.api#documentation": "

The ARN of the resource that represents your subscription to the standard.

", "smithy.api#required": {} } }, @@ -34309,7 +34309,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of a standard.

", + "smithy.api#documentation": "

The ARN of the standard.

", "smithy.api#required": {} } }, @@ -34325,14 +34325,14 @@ "target": "com.amazonaws.securityhub#StandardsStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of the standard subscription.

\n

The status values are as follows:

\n
    \n
  • \n

    \n PENDING - Standard is in the process of being enabled.

    \n
    • \n
  • \n

    \n READY - Standard is enabled.

    \n
    • \n
  • \n

    \n INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

    \n
    • \n
  • \n

    \n DELETING - Standard is in the process of being disabled.

    \n
    • \n
  • \n

    \n FAILED - Standard could not be disabled.

    \n
    • \n
", + "smithy.api#documentation": "

The status of your subscription to the standard. Possible values are:

\n
    \n
  • \n

    \n PENDING - The standard is in the process of being enabled. Or the standard is already \n enabled and Security Hub is adding new controls to the standard.

    \n
    • \n
  • \n

    \n READY - The standard is enabled.

    \n
    • \n
  • \n

    \n INCOMPLETE - The standard could not be enabled completely. One or more errors (StandardsStatusReason) \n occurred when Security Hub attempted to enable the standard.

    \n
    • \n
  • \n

    \n DELETING - The standard is in the process of being disabled.

    \n
    • \n
  • \n

    \n FAILED - The standard could not be disabled. One or more errors (StandardsStatusReason) \n occurred when Security Hub attempted to disable the standard.

    \n
    • \n
", "smithy.api#required": {} } }, "StandardsControlsUpdatable": { "target": "com.amazonaws.securityhub#StandardsControlsUpdatable", "traits": { - "smithy.api#documentation": "

Indicates whether the controls associated with this standards subscription can be viewed and updated.

\n

The values are as follows:

\n
    \n
  • \n

    \n READY_FOR_UPDATES - Controls associated with this standards subscription can be viewed and updated.

    \n
    • \n
  • \n

    \n NOT_READY_FOR_UPDATES - Controls associated with this standards subscription cannot be retrieved or updated yet. Security Hub is still processing a request to create the controls.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:

\n
    \n
  • \n

    \n READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.

    \n
    • \n
  • \n

    \n NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.

    \n
    • \n
" } }, "StandardsStatusReason": { diff --git a/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json b/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json index c71304b9..f6d6de10 100644 --- a/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json +++ b/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json @@ -10524,7 +10524,7 @@ "AccessLevelFilter": { "target": "com.amazonaws.servicecatalog#AccessLevelFilter", "traits": { - "smithy.api#documentation": "

The access level to use to obtain results. The default is User.

" + "smithy.api#documentation": "

The access level to use to obtain results. The default is\n Account.

" } }, "Filters": { diff --git a/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json b/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json index 3eebbbc7..0b2c791b 100644 --- a/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json +++ b/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json @@ -336,7 +336,7 @@ "ErrorCode": { "target": "com.amazonaws.servicequotas#ErrorCode", "traits": { - "smithy.api#documentation": "

Service Quotas returns the following error values:

\n
    \n
  • \n

    \n DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the\n required permissions to complete the action. To resolve the error, you must have\n permission to access the Amazon Web Service or quota.

    \n
    • \n
  • \n

    \n DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling\n Service Quotas.

    \n
    • \n
  • \n

    \n DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not\n available.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in\n Service Quotas.

    \n
    • \n
" + "smithy.api#documentation": "

Service Quotas returns the following error values:

\n
    \n
  • \n

    \n DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the\n required permissions to complete the action. To resolve the error, you must have\n permission to access the Amazon Web Services service or quota.

    \n
    • \n
  • \n

    \n DEPENDENCY_THROTTLING_ERROR - The Amazon Web Services service is throttling\n Service Quotas.

    \n
    • \n
  • \n

    \n DEPENDENCY_SERVICE_ERROR - The Amazon Web Services service is not\n available.

    \n
    • \n
  • \n

    \n SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in\n Service Quotas.

    \n
    • \n
" } }, "ErrorMessage": { @@ -561,7 +561,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the applied quota value for the specified quota. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota,\n the quota is not retrieved.

" + "smithy.api#documentation": "

Retrieves the applied quota value for the specified account-level or resource-level quota. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota,\n the quota is not retrieved.

" } }, "com.amazonaws.servicequotas#GetServiceQuotaIncreaseRequestFromTemplate": { @@ -668,7 +668,7 @@ "ContextId": { "target": "com.amazonaws.servicequotas#QuotaContextId", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.

" + "smithy.api#documentation": "

Specifies the resource with an Amazon Resource Name (ARN).

" } } }, @@ -781,7 +781,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the default values for the quotas for the specified Amazon Web Service. A default\n value does not reflect any quota increases.

", + "smithy.api#documentation": "

Lists the default values for the quotas for the specified Amazon Web Services service. A default\n value does not reflect any quota increases.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -866,7 +866,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the quota increase requests for the specified Amazon Web Service.

", + "smithy.api#documentation": "

Retrieves the quota increase requests for the specified Amazon Web Services service. Filter responses to return quota requests at \n either the account level, resource level, or all levels. Responses include any open or closed requests within 90 days.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -904,7 +904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the quota increase requests for the specified quota.

", + "smithy.api#documentation": "

Retrieves the quota increase requests for the specified quota. Filter responses to return quota requests at either the\n account level, resource level, or all levels.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -951,7 +951,7 @@ "QuotaRequestedAtLevel": { "target": "com.amazonaws.servicequotas#AppliedLevelEnum", "traits": { - "smithy.api#documentation": "

Specifies at which level within the Amazon Web Services account the quota request applies to.

" + "smithy.api#documentation": "

Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

" } } }, @@ -1009,7 +1009,7 @@ "QuotaRequestedAtLevel": { "target": "com.amazonaws.servicequotas#AppliedLevelEnum", "traits": { - "smithy.api#documentation": "

Specifies at which level within the Amazon Web Services account the quota request applies to.

" + "smithy.api#documentation": "

Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

" } } }, @@ -1162,7 +1162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the applied quota values for the specified Amazon Web Service. For some quotas, only\n the default values are available. If the applied quota value is not available for a\n quota, the quota is not retrieved.

", + "smithy.api#documentation": "

Lists the applied quota values for the specified Amazon Web Services service. For some quotas, only\n the default values are available. If the applied quota value is not available for a\n quota, the quota is not retrieved. Filter responses to return applied quota values at either the account level,\n resource level, or all levels.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1202,7 +1202,7 @@ "QuotaAppliedAtLevel": { "target": "com.amazonaws.servicequotas#AppliedLevelEnum", "traits": { - "smithy.api#documentation": "

Specifies at which level of granularity that the quota value is applied.

" + "smithy.api#documentation": "

Filters the response to return applied quota values for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

" } } }, @@ -1256,7 +1256,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the names and codes for the Amazon Web Services integrated with Service Quotas.

", + "smithy.api#documentation": "

Lists the names and codes for the Amazon Web Services services integrated with Service Quotas.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1297,7 +1297,7 @@ "Services": { "target": "com.amazonaws.servicequotas#ServiceInfoListDefinition", "traits": { - "smithy.api#documentation": "

The list of the Amazon Web Service names and service codes.

" + "smithy.api#documentation": "

The list of the Amazon Web Services service names and service codes.

" } } }, @@ -1658,24 +1658,24 @@ "ContextScope": { "target": "com.amazonaws.servicequotas#QuotaContextScope", "traits": { - "smithy.api#documentation": "

Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

" + "smithy.api#documentation": "

Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.

" } }, "ContextScopeType": { "target": "com.amazonaws.servicequotas#QuotaContextScopeType", "traits": { - "smithy.api#documentation": "

When the ContextScope is RESOURCE, then this specifies the resource type of the specified resource.

" + "smithy.api#documentation": "

Specifies the resource type to which the quota can be applied.

" } }, "ContextId": { "target": "com.amazonaws.servicequotas#QuotaContextId", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.

" + "smithy.api#documentation": "

Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven\u2019t previously applied a quota value, and any new resources you create in your Amazon Web Services account.

" } } }, "traits": { - "smithy.api#documentation": "

A structure that describes the context for a service quota. The context identifies what the quota applies to.

" + "smithy.api#documentation": "

A structure that describes the context for a resource-level quota. For resource-level quotas, such as Instances per OpenSearch Service Domain, you can apply the quota value at the resource-level for each OpenSearch Service Domain in your Amazon Web Services account. Together the attributes of this structure help you understand how the quota is implemented by Amazon Web Services and how you can manage it. For quotas such as Amazon OpenSearch Service Domains which can be managed at the account-level for each Amazon Web Services Region, the QuotaContext field is absent. See the attribute descriptions below to further understand how to use them.

" } }, "com.amazonaws.servicequotas#QuotaContextScope": { @@ -1698,6 +1698,16 @@ "com.amazonaws.servicequotas#QuotaContextScopeType": { "type": "string" }, + "com.amazonaws.servicequotas#QuotaDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 350 + }, + "smithy.api#pattern": "^.{0,350}$" + } + }, "com.amazonaws.servicequotas#QuotaExceededException": { "type": "structure", "members": { @@ -1800,7 +1810,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits a quota increase request for the specified quota.

" + "smithy.api#documentation": "

Submits a quota increase request for the specified quota at the account or resource level.

" } }, "com.amazonaws.servicequotas#RequestServiceQuotaIncreaseRequest": { @@ -1830,7 +1840,13 @@ "ContextId": { "target": "com.amazonaws.servicequotas#QuotaContextId", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.

" + "smithy.api#documentation": "

Specifies the resource with an Amazon Resource Name (ARN).

" + } + }, + "SupportCaseAllowed": { + "target": "com.amazonaws.servicequotas#SupportCaseAllowed", + "traits": { + "smithy.api#documentation": "

Specifies if an Amazon Web Services Support case can be opened for the quota increase request. This parameter is optional.

\n

By default, this flag is set to True and Amazon Web Services may create a support case for some quota increase requests. \n You can set this flag to False \n if you do not want a support case created when you request a quota increase. If you set the flag to False, \n Amazon Web Services does not open a support case and updates the request status to Not approved.

" } } }, @@ -1947,7 +1963,7 @@ "Status": { "target": "com.amazonaws.servicequotas#RequestStatus", "traits": { - "smithy.api#documentation": "

The state of the quota increase request.

" + "smithy.api#documentation": "

The state of the quota increase request.

\n
    \n
  • \n

    \n PENDING: The quota increase request is under review by Amazon Web Services.

    \n
    • \n
  • \n

    \n CASE_OPENED: Service Quotas opened a support case to process the quota increase\n request. Follow-up on the support case for more information.

    \n
    • \n
  • \n

    \n APPROVED: The quota increase request is approved.

    \n
    • \n
  • \n

    \n DENIED: The quota increase request can't be approved by Service Quotas. Contact\n Amazon Web Services Support for more details.

    \n
    • \n
  • \n

    \n NOT APPROVED: The quota increase request can't be approved by Service Quotas. Contact\n Amazon Web Services Support for more details.

    \n
    • \n
  • \n

    \n CASE_CLOSED: The support case associated with this quota increase request was closed.\n Check the support case correspondence for the outcome of your quota request.

    \n
    • \n
  • \n

    \n INVALID_REQUEST: Service Quotas couldn't process your resource-level quota increase request because the\n Amazon Resource Name (ARN) specified as part of the ContextId is invalid.

    \n
    • \n
" } }, "Created": { @@ -1990,7 +2006,7 @@ "QuotaRequestedAtLevel": { "target": "com.amazonaws.servicequotas#AppliedLevelEnum", "traits": { - "smithy.api#documentation": "

Specifies at which level within the Amazon Web Services account the quota request applies to.

" + "smithy.api#documentation": "

Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

" } }, "QuotaContext": { @@ -2066,7 +2082,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an Amazon Web Service.

" + "smithy.api#documentation": "

Information about an Amazon Web Services service.

" } }, "com.amazonaws.servicequotas#ServiceInfoListDefinition": { @@ -2158,7 +2174,7 @@ "QuotaAppliedAtLevel": { "target": "com.amazonaws.servicequotas#AppliedLevelEnum", "traits": { - "smithy.api#documentation": "

Specifies at which level of granularity that the quota value is applied.

" + "smithy.api#documentation": "

Filters the response to return applied quota values for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

" } }, "QuotaContext": { @@ -2166,6 +2182,12 @@ "traits": { "smithy.api#documentation": "

The context for this service quota.

" } + }, + "Description": { + "target": "com.amazonaws.servicequotas#QuotaDescription", + "traits": { + "smithy.api#documentation": "

The quota description.

" + } } }, "traits": { @@ -2345,7 +2367,7 @@ "name": "servicequotas" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow.\n Quotas, also referred to as limits, are the maximum number of resources that you can\n create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.

", + "smithy.api#documentation": "

With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow.\n Quotas, also referred to as limits, are the maximum number of resources that you can\n create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.

\n

You need Amazon Web Services CLI version 2.13.20 or higher to view and manage resource-level quotas such as Instances\n per domain for Amazon OpenSearch Service.

", "smithy.api#title": "Service Quotas", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3311,6 +3333,9 @@ "smithy.api#pattern": "^(Sum|Maximum)$" } }, + "com.amazonaws.servicequotas#SupportCaseAllowed": { + "type": "boolean" + }, "com.amazonaws.servicequotas#Tag": { "type": "structure", "members": { diff --git a/sesv2/service/2019-09-27/sesv2-2019-09-27.json b/sesv2/service/2019-09-27/sesv2-2019-09-27.json index c9e69007..785cd174 100644 --- a/sesv2/service/2019-09-27/sesv2-2019-09-27.json +++ b/sesv2/service/2019-09-27/sesv2-2019-09-27.json @@ -153,6 +153,140 @@ "smithy.api#documentation": "

Used to associate a configuration set with a MailManager archive.

" } }, + "com.amazonaws.sesv2#Attachment": { + "type": "structure", + "members": { + "RawContent": { + "target": "com.amazonaws.sesv2#RawAttachmentData", + "traits": { + "smithy.api#documentation": "

The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES\n directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you.

", + "smithy.api#required": {} + } + }, + "ContentDisposition": { + "target": "com.amazonaws.sesv2#AttachmentContentDisposition", + "traits": { + "smithy.api#documentation": "

A standard descriptor indicating how the attachment should be rendered in the email.\n Supported values: ATTACHMENT or INLINE.

" + } + }, + "FileName": { + "target": "com.amazonaws.sesv2#AttachmentFileName", + "traits": { + "smithy.api#documentation": "

The file name for the attachment as it will appear in the email.\n Amazon SES restricts certain file extensions. To ensure attachments are accepted,\n check the Unsupported attachment types\n in the Amazon SES Developer Guide.

", + "smithy.api#required": {} + } + }, + "ContentDescription": { + "target": "com.amazonaws.sesv2#AttachmentContentDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the attachment content.

" + } + }, + "ContentId": { + "target": "com.amazonaws.sesv2#AttachmentContentId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

" + } + }, + "ContentTransferEncoding": { + "target": "com.amazonaws.sesv2#AttachmentContentTransferEncoding", + "traits": { + "smithy.api#documentation": "

Specifies how the attachment is encoded.\n Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

" + } + }, + "ContentType": { + "target": "com.amazonaws.sesv2#AttachmentContentType", + "traits": { + "smithy.api#documentation": "

The MIME type of the attachment.

\n \n

Example: application/pdf, image/jpeg\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains metadata and attachment raw content.

" + } + }, + "com.amazonaws.sesv2#AttachmentContentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.sesv2#AttachmentContentDisposition": { + "type": "enum", + "members": { + "ATTACHMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT" + } + }, + "INLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INLINE" + } + } + } + }, + "com.amazonaws.sesv2#AttachmentContentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 78 + } + } + }, + "com.amazonaws.sesv2#AttachmentContentTransferEncoding": { + "type": "enum", + "members": { + "BASE64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64" + } + }, + "QUOTED_PRINTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUOTED_PRINTABLE" + } + }, + "SEVEN_BIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVEN_BIT" + } + } + } + }, + "com.amazonaws.sesv2#AttachmentContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 78 + } + } + }, + "com.amazonaws.sesv2#AttachmentFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.sesv2#AttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#Attachment" + } + }, "com.amazonaws.sesv2#AttributesData": { "type": "string" }, @@ -3609,7 +3743,7 @@ "Simple": { "target": "com.amazonaws.sesv2#Message", "traits": { - "smithy.api#documentation": "

The simple email message. The message consists of a subject and a message body.

" + "smithy.api#documentation": "

The simple email message. The message consists of a subject, message body and attachments list.

" } }, "Raw": { @@ -3626,7 +3760,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that defines the entire content of the email, including the message headers\n and the body content. You can create a simple email message, in which you specify the\n subject and the text and HTML versions of the message body. You can also create raw\n messages, in which you specify a complete MIME-formatted message. Raw messages can\n include attachments and custom headers.

" + "smithy.api#documentation": "

An object that defines the entire content of the email, including the message headers, body content,\n and attachments. For a simple email message, you specify the subject and provide both text\n and HTML versions of the message body. You can also add attachments to simple and templated\n messages. For a raw message, you provide a complete MIME-formatted message, which can\n include custom headers and attachments.

" } }, "com.amazonaws.sesv2#EmailInsights": { @@ -6704,7 +6838,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the contact lists available.

", + "smithy.api#documentation": "

Lists all of the contact lists available.

\n

If your output includes a \"NextToken\" field with a string value, this indicates there may be additional\n contacts on the filtered list - regardless of the number of contacts returned.

", "smithy.api#http": { "method": "GET", "uri": "/v2/email/contact-lists", @@ -8059,6 +8193,12 @@ "traits": { "smithy.api#documentation": "

The list of message headers that will be added to the email message.

" } + }, + "Attachments": { + "target": "com.amazonaws.sesv2#AttachmentList", + "traits": { + "smithy.api#documentation": "

The List of attachments to include in your email. All recipients will receive the same attachments.

" + } } }, "traits": { @@ -10140,6 +10280,9 @@ } } }, + "com.amazonaws.sesv2#RawAttachmentData": { + "type": "blob" + }, "com.amazonaws.sesv2#RawMessage": { "type": "structure", "members": { @@ -11427,7 +11570,7 @@ { "conditions": [], "endpoint": { - "url": "https://{EndpointId}.endpoints.email.{PartitionResult#dualStackDnsSuffix}", + "url": "https://{EndpointId}.endpoints.email.global.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { @@ -12412,7 +12555,7 @@ } ] }, - "url": "https://abc123.456def.endpoints.email.api.aws" + "url": "https://abc123.456def.endpoints.email.global.api.aws" } }, "params": { @@ -12918,6 +13061,12 @@ "traits": { "smithy.api#documentation": "

The list of message headers that will be added to the email message.

" } + }, + "Attachments": { + "target": "com.amazonaws.sesv2#AttachmentList", + "traits": { + "smithy.api#documentation": "

The List of attachments to include in your email. All recipients will receive the same attachments.

" + } } }, "traits": { diff --git a/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json b/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json index 09d98f77..a5825894 100644 --- a/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json +++ b/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json @@ -193,6 +193,12 @@ "traits": { "smithy.api#enumValue": "UNKNOWN_ERROR" } + }, + "INSUFFICIENT_PERMISSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_PERMISSIONS" + } } } }, @@ -6775,7 +6781,7 @@ "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

This field is only used as part of a JoinDomain request. It is not\n affected by Active Directory connectivity changes that occur after the\n JoinDomain request succeeds.

\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": "

Indicates the status of the gateway as a member of the Active Directory domain.

\n \n

This field is only used as part of a JoinDomain request. It is not\n affected by Active Directory connectivity changes that occur after the\n JoinDomain request succeeds.

\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 INSUFFICIENT_PERMISSIONS: Indicates that the JoinDomain\n operation failed because the specified user lacks the necessary permissions to join\n the domain.

    \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
" } } }, @@ -6866,7 +6872,12 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of existing cache reports for all file shares associated with your\n Amazon Web Services account. This list includes all information provided by the\n DescribeCacheReport action, such as report name, status, completion\n progress, start time, end time, filters, and tags.

" + "smithy.api#documentation": "

Returns a list of existing cache reports for all file shares associated with your\n Amazon Web Services account. This list includes all information provided by the\n DescribeCacheReport action, such as report name, status, completion\n progress, start time, end time, filters, and tags.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "CacheReportList" + } } }, "com.amazonaws.storagegateway#ListCacheReportsInput": { @@ -7725,7 +7736,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1000 + "max": 2000 } } }, @@ -9207,14 +9218,14 @@ "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon S3 bucket where the cache report will be saved.

\n \n

We do not recommend saving the cache report to the same Amazon S3 bucket for\n which you are generating the report.

\n

This field does not accept access point ARNs.

\n ", + "smithy.api#documentation": "

The ARN of the Amazon S3 bucket where you want to save the cache report.

\n \n

We do not recommend saving the cache report to the same Amazon S3 bucket for\n which you are generating the report.

\n

This field does not accept access point ARNs.

\n ", "smithy.api#required": {} } }, "BucketRegion": { "target": "com.amazonaws.storagegateway#RegionId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon S3 bucket associated with the file\n share for which you want to generate the cache report.

", + "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon S3 bucket where you want to save the\n cache report.

", "smithy.api#required": {} } }, diff --git a/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json b/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json index 27ce4d6f..04decc69 100644 --- a/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json +++ b/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json @@ -201,6 +201,12 @@ "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Saudi Arabia.\n

" } }, + "indonesiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#IndonesiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n

" + } + }, "vietnamAdditionalInfo": { "target": "com.amazonaws.taxsettings#VietnamAdditionalInfo", "traits": { @@ -218,6 +224,12 @@ "traits": { "smithy.api#documentation": "

Additional tax information to specify for a TRN in Greece.

" } + }, + "uzbekistanAdditionalInfo": { + "target": "com.amazonaws.taxsettings#UzbekistanAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Uzbekistan.\n

" + } } }, "traits": { @@ -323,6 +335,12 @@ "smithy.api#documentation": "

\n Additional tax information in India. \n

" } }, + "indonesiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#IndonesiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Indonesia.

" + } + }, "vietnamAdditionalInfo": { "target": "com.amazonaws.taxsettings#VietnamAdditionalInfo", "traits": { @@ -340,6 +358,12 @@ "traits": { "smithy.api#documentation": "

Additional tax information to specify for a TRN in Greece.\n

" } + }, + "uzbekistanAdditionalInfo": { + "target": "com.amazonaws.taxsettings#UzbekistanAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Uzbekistan.\n

" + } } }, "traits": { @@ -707,7 +731,7 @@ "aws.iam#iamAction": { "documentation": "Grants store permission" }, - "smithy.api#documentation": "

Adds or updates tax registration for multiple accounts in batch. This can be used to add\n or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
    • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
    • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
    • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
    • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
  • \n

    \n RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

    \n
    • \n
  • \n

    For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

    \n
    • \n
  • \n

    For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

    \n
    • \n
  • \n

    For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

    \n
    • \n
  • \n

    For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you\u2019re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number.

    \n
    • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
    • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
    • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
    • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
    • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
    • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
    • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
    • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
    • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
    • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

      \n
      • \n
    \n
    • \n
  • \n

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
    • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
    • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
", + "smithy.api#documentation": "

Adds or updates tax registration for multiple accounts in batch. This can be used to add\n or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
    • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
    • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
    • \n
\n

\n Indonesia\n

\n
    \n
  • \n

    \n PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you\u2019re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022.

    \n
    • \n
  • \n

    \n BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you\u2019re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak).

    \n
    • \n
  • \n

    You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08.

    \n

    For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08.

    \n
    • \n
  • \n

    If ppnExceptionDesignationCode is 07, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object.

    \n
    • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
    • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
  • \n

    \n RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

    \n
    • \n
  • \n

    For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

    \n
    • \n
  • \n

    For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

    \n
    • \n
  • \n

    For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

    \n
    • \n
  • \n

    For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you\u2019re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number.

    \n
    • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
    • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
    • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
    • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
    • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
    • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
    • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
    • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
    • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
    • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

      \n
      • \n
    \n
    • \n
  • \n

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
    • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
    • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
", "smithy.api#http": { "code": 200, "method": "POST", @@ -997,6 +1021,12 @@ "smithy.api#pattern": "^(\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1]))$" } }, + "com.amazonaws.taxsettings#DecisionNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([a-zA-Z0-9/.\\-]{0,200})$" + } + }, "com.amazonaws.taxsettings#DeleteSupplementalTaxRegistration": { "type": "operation", "input": { @@ -1623,6 +1653,61 @@ "smithy.api#pattern": "^([0-9]{10})$" } }, + "com.amazonaws.taxsettings#IndonesiaAdditionalInfo": { + "type": "structure", + "members": { + "taxRegistrationNumberType": { + "target": "com.amazonaws.taxsettings#IndonesiaTaxRegistrationNumberType", + "traits": { + "smithy.api#documentation": "

The tax registration number type.

" + } + }, + "ppnExceptionDesignationCode": { + "target": "com.amazonaws.taxsettings#PpnExceptionDesignationCode", + "traits": { + "smithy.api#documentation": "

Exception code if you are designated by Directorate General of Taxation (DGT) as a VAT collector, non-collected VAT, or VAT-exempt customer.

" + } + }, + "decisionNumber": { + "target": "com.amazonaws.taxsettings#DecisionNumber", + "traits": { + "smithy.api#documentation": "

VAT-exempt customers have a Directorate General of Taxation (DGT) exemption letter or certificate (Surat Keterangan Bebas) decision number. Non-collected VAT have a DGT letter or certificate (Surat Keterangan Tidak Dipungut).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Indonesia.

" + } + }, + "com.amazonaws.taxsettings#IndonesiaTaxRegistrationNumberType": { + "type": "enum", + "members": { + "NIK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NIK" + } + }, + "PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PassportNumber" + } + }, + "NPWP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NPWP" + } + }, + "NITKU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NITKU" + } + } + } + }, "com.amazonaws.taxsettings#Industries": { "type": "enum", "members": { @@ -2254,6 +2339,12 @@ "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" } }, + "com.amazonaws.taxsettings#PpnExceptionDesignationCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(01|02|03|07|08)$" + } + }, "com.amazonaws.taxsettings#PutSupplementalTaxRegistration": { "type": "operation", "input": { @@ -2497,7 +2588,7 @@ "aws.iam#iamAction": { "documentation": "Grants store permission" }, - "smithy.api#documentation": "

Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
    • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
    • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
    • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
    • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
  • \n

    \n RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

    \n
    • \n
  • \n

    For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

    \n
    • \n
  • \n

    For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

    \n
    • \n
  • \n

    For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

    \n
    • \n
  • \n

    For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you\u2019re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number.

    \n
    • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
    • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
    • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
    • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
    • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
    • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
    • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
    • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
    • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
    • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

      \n
      • \n
    \n
    • \n
  • \n

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
    • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
    • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
", + "smithy.api#documentation": "

Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
    • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
    • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
    • \n
\n

\n Indonesia\n

\n
    \n
  • \n

    \n PutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you\u2019re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022.

    \n
    • \n
  • \n

    \n BatchPutTaxRegistration: The use of this operation to submit tax information is subject to the Amazon Web Services service terms. By submitting, you\u2019re providing consent for Amazon Web Services to validate NIK, NPWP, and NITKU data, provided by you with the Directorate General of Taxes of Indonesia in accordance with the Minister of Finance Regulation (PMK) Number 112/PMK.03/2022, through our third-party partner PT Achilles Advanced Management (OnlinePajak).

    \n
    • \n
  • \n

    You must specify the taxRegistrationNumberType in the indonesiaAdditionalInfo field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If you specify decisionNumber, you must specify the ppnExceptionDesignationCode in the indonesiaAdditionalInfo field of the additionalTaxInformation object. If the taxRegistrationNumberType is set to NPWP or NITKU, valid values for ppnExceptionDesignationCode are either 01, 02, 03, 07, or 08.

    \n

    For other taxRegistrationNumberType values, ppnExceptionDesignationCode must be either 01, 07, or 08.

    \n
    • \n
  • \n

    If ppnExceptionDesignationCode is 07, you must specify the decisionNumber in the indonesiaAdditionalInfo field of the additionalTaxInformation object.

    \n
    • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
    • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
    • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
  • \n

    \n RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

    \n
    • \n
  • \n

    For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

    \n
    • \n
  • \n

    For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

    \n
    • \n
  • \n

    For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

    \n
    • \n
  • \n

    For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration that you\u2019re an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD), and have a valid SST number.

    \n
    • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
    • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
    • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
    • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
    • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
    • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
    • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
    • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
    • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
    • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
    • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
      • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

      \n
      • \n
    \n
    • \n
  • \n

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
    • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
    • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
    • \n
", "smithy.api#http": { "code": 200, "method": "POST", @@ -4541,6 +4632,43 @@ "smithy.api#pattern": "^https.*\\S.*$" } }, + "com.amazonaws.taxsettings#UzbekistanAdditionalInfo": { + "type": "structure", + "members": { + "taxRegistrationNumberType": { + "target": "com.amazonaws.taxsettings#UzbekistanTaxRegistrationNumberType", + "traits": { + "smithy.api#documentation": "

\n The tax registration number type. The tax registration number type valid values are Business and Individual.\n

" + } + }, + "vatRegistrationNumber": { + "target": "com.amazonaws.taxsettings#VatRegistrationNumber", + "traits": { + "smithy.api#documentation": "

\n The unique 12-digit number issued to identify VAT-registered identities in Uzbekistan.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Uzbekistan.\n

" + } + }, + "com.amazonaws.taxsettings#UzbekistanTaxRegistrationNumberType": { + "type": "enum", + "members": { + "BUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Business" + } + }, + "INDIVIDUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Individual" + } + } + } + }, "com.amazonaws.taxsettings#ValidationException": { "type": "structure", "members": { @@ -4626,6 +4754,12 @@ "target": "com.amazonaws.taxsettings#ValidationExceptionField" } }, + "com.amazonaws.taxsettings#VatRegistrationNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.taxsettings#VerificationDetails": { "type": "structure", "members": { diff --git a/transcribe/service/2017-10-26/transcribe-2017-10-26.json b/transcribe/service/2017-10-26/transcribe-2017-10-26.json index 56edcfc2..f2259af2 100644 --- a/transcribe/service/2017-10-26/transcribe-2017-10-26.json +++ b/transcribe/service/2017-10-26/transcribe-2017-10-26.json @@ -2978,6 +2978,12 @@ "smithy.api#enumValue": "wo-SN" } }, + "ZH_HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-HK" + } + }, "ZU_ZA": { "target": "smithy.api#Unit", "traits": { diff --git a/transfer/service/2018-11-05/transfer-2018-11-05.json b/transfer/service/2018-11-05/transfer-2018-11-05.json index f1a993b1..27c7422e 100644 --- a/transfer/service/2018-11-05/transfer-2018-11-05.json +++ b/transfer/service/2018-11-05/transfer-2018-11-05.json @@ -154,7 +154,7 @@ "EncryptionAlgorithm": { "target": "com.amazonaws.transfer#EncryptionAlg", "traits": { - "smithy.api#documentation": "

The algorithm that is used to encrypt the file.

\n

Note the following:

\n
    \n
  • \n

    Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

    \n
    • \n
  • \n

    You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that\n no traffic is sent in clear text.

    \n
    • \n
" + "smithy.api#documentation": "

The algorithm that is used to encrypt the file.

Note the following:

  • Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

  • You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

" } }, "SigningAlgorithm": { @@ -166,30 +166,30 @@ "MdnSigningAlgorithm": { "target": "com.amazonaws.transfer#MdnSigningAlg", "traits": { - "smithy.api#documentation": "

The signing algorithm for the MDN response.

\n \n

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

\n " + "smithy.api#documentation": "

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

" } }, "MdnResponse": { "target": "com.amazonaws.transfer#MdnResponse", "traits": { - "smithy.api#documentation": "

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether\n the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

\n
    \n
  • \n

    \n SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

    \n
    • \n
  • \n

    \n NONE: Specifies that no MDN response is required.

    \n
    • \n
" + "smithy.api#documentation": "

Used for outbound requests (from an Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

  • SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

  • NONE: Specifies that no MDN response is required.

" } }, "BasicAuthSecretId": { "target": "com.amazonaws.transfer#As2ConnectorSecretId", "traits": { - "smithy.api#documentation": "

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication,\n you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

\n

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

\n

If the connector should use Basic authentication, the secret needs to be in the following format:

\n

\n {\n \"Username\": \"user-name\",\n \"Password\": \"user-password\"\n }\n

\n

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

\n

Note the following:

\n
    \n
  • \n

    You are storing these credentials in Secrets Manager, not passing them directly into this API.

    \n
    • \n
  • \n

    If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication.\n However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

    \n
    • \n
\n

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

\n

\n update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=\"\"'\n

" + "smithy.api#documentation": "

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ \"Username\": \"user-name\", \"Password\": \"user-password\" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

  • You are storing these credentials in Secrets Manager, not passing them directly into this API.

  • If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=\"\"'

" } }, "PreserveContentType": { "target": "com.amazonaws.transfer#PreserveContentType", "traits": { - "smithy.api#documentation": "

Allows you to use the Amazon S3 Content-Type that is associated with objects in S3 instead of\n having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector\n from the console, but disabled by default when you create an AS2 connector by calling the API directly.

" + "smithy.api#documentation": "

Allows you to use the Amazon S3 Content-Type that is associated with objects in S3 instead of having the content type mapped based on the file extension. This parameter is enabled by default when you create an AS2 connector from the console, but disabled by default when you create an AS2 connector by calling the API directly.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound\n processes, to connect the Transfer Family customer with the trading partner.

" + "smithy.api#documentation": "

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

" } }, "com.amazonaws.transfer#As2ConnectorSecretId": { @@ -432,7 +432,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when the UpdateServer is called for a file transfer\n protocol-enabled server that has VPC as the endpoint type and the server's\n VpcEndpointID is not in the available state.

", + "smithy.api#documentation": "

This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -457,7 +457,7 @@ "FailureCode": { "target": "com.amazonaws.transfer#FailureCode", "traits": { - "smithy.api#documentation": "

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND\n

" + "smithy.api#documentation": "

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

" } }, "FailureMessage": { @@ -552,19 +552,19 @@ "DestinationFileLocation": { "target": "com.amazonaws.transfer#InputFileLocation", "traits": { - "smithy.api#documentation": "

Specifies the location for the file being copied. Use ${Transfer:UserName} or\n ${Transfer:UploadDate} in this field to parametrize the destination prefix by\n username or uploaded date.

\n
    \n
  • \n

    Set the value of DestinationFileLocation to\n ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket\n that is prefixed with the name of the Transfer Family user that uploaded the\n file.

    \n
    • \n
  • \n

    Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to \n an Amazon S3 bucket that is prefixed with the date of the upload.

    \n \n

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file\n is uploaded in UTC.

    \n     \n
    • \n
" + "smithy.api#documentation": "

Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

  • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

  • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
" } }, "OverwriteExisting": { "target": "com.amazonaws.transfer#OverwriteExisting", "traits": { - "smithy.api#documentation": "

A flag that indicates whether to overwrite an existing file of the same name.\n The default is FALSE.

\n

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

\n
    \n
  • \n

    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

    \n
    • \n
  • \n

    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

    \n
    • \n
" + "smithy.api#documentation": "

A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

  • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

  • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

" } }, "SourceFileLocation": { "target": "com.amazonaws.transfer#SourceFileLocation", "traits": { - "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.

\n
    \n
  • \n

    To use the previous file as the input, enter ${previous.file}.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.

    \n
    • \n
  • \n

    To use the originally uploaded file location as input for this step, enter ${original.file}.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

" } } }, @@ -598,7 +598,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n CreateAccess to limit the access to the correct set of users who need this\n ability.

" + "smithy.api#documentation": "

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

" } }, "com.amazonaws.transfer#CreateAccessRequest": { @@ -607,25 +607,25 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

\n

For session policies, 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

For an example of a session policy, see Example\n session policy.

\n

For more information, see AssumeRole in the Security Token Service API\n Reference.

\n " + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Security Token Service API Reference.

" } }, "PosixProfile": { @@ -634,7 +634,7 @@ "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

", "smithy.api#required": {} } }, @@ -648,7 +648,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -670,7 +670,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

The external identifier of the group whose users have access to your Amazon S3 or Amazon\n EFS resources over the enabled protocols using Transfer Family.

", + "smithy.api#documentation": "

The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.

", "smithy.api#required": {} } } @@ -714,7 +714,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership,\n between an Transfer Family server and an AS2 process. The agreement defines the file and message\n transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family\n combines a server, local profile, partner profile, certificate, and other\n attributes.

\n

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

\n \n

Specify either\n BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

\n " + "smithy.api#documentation": "

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

" } }, "com.amazonaws.transfer#CreateAgreementRequest": { @@ -729,7 +729,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a server instance. This is the specific server\n that the agreement uses.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

", "smithy.api#required": {} } }, @@ -750,20 +750,20 @@ "BaseDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

\n

A BaseDirectory example is\n /amzn-s3-demo-bucket/home/mydirectory.

" + "smithy.api#documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.

" } }, "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

", + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.transfer#AgreementStatusType", "traits": { - "smithy.api#documentation": "

The status of the agreement. The agreement can be either ACTIVE or\n INACTIVE.

" + "smithy.api#documentation": "

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

" } }, "Tags": { @@ -775,19 +775,19 @@ "PreserveFilename": { "target": "com.amazonaws.transfer#PreserveFilenameType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload\n filename when saving it.\n

\n
    \n
  • \n

    \n ENABLED: the filename provided by your trading parter is preserved when the file is saved.

    \n
    • \n
  • \n

    \n DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as\n described in File names and locations.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

  • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

  • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

" } }, "EnforceMessageSigning": { "target": "com.amazonaws.transfer#EnforceMessageSigningType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not unsigned messages from your trading partners will be accepted.\n

\n
    \n
  • \n

    \n ENABLED: Transfer Family rejects unsigned messages from your trading partner.

    \n
    • \n
  • \n

    \n DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not unsigned messages from your trading partners will be accepted.

  • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

  • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

" } }, "CustomDirectories": { "target": "com.amazonaws.transfer#CustomDirectoriesType", "traits": { - "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

\n
    \n
  • \n

    Failed files

    \n
    • \n
  • \n

    MDN files

    \n
    • \n
  • \n

    Payload files

    \n
    • \n
  • \n

    Status files

    \n
    • \n
  • \n

    Temporary files

    \n
    • \n
" + "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

  • Failed files

  • MDN files

  • Payload files

  • Status files

  • Temporary files

" } } }, @@ -801,7 +801,7 @@ "AgreementId": { "target": "com.amazonaws.transfer#AgreementId", "traits": { - "smithy.api#documentation": "

The unique identifier for the agreement. Use this ID for deleting, or updating an\n agreement, as well as in any other API calls that require that you specify the agreement\n ID.

", + "smithy.api#documentation": "

The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

", "smithy.api#required": {} } } @@ -845,7 +845,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

\n \n

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

\n " + "smithy.api#documentation": "

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors.

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

" } }, "com.amazonaws.transfer#CreateConnectorRequest": { @@ -867,14 +867,14 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

", + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

", "smithy.api#required": {} } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

" } }, "Tags": { @@ -955,14 +955,14 @@ "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the \n RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages\n sent from the partner. For outbound connectors, this is the AS2-To header for the\n AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

", + "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

", "smithy.api#required": {} } }, "ProfileType": { "target": "com.amazonaws.transfer#ProfileType", "traits": { - "smithy.api#documentation": "

Determines the type of profile to create:

\n
    \n
  • \n

    Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

    \n
    • \n
  • \n

    Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

    \n
    • \n
", + "smithy.api#documentation": "

Determines the type of profile to create:

  • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

  • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

", "smithy.api#required": {} } }, @@ -1057,7 +1057,7 @@ "logs:DescribeLogGroups" ] }, - "smithy.api#documentation": "

Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated ServerId property that is assigned to the\n newly created server.

" + "smithy.api#documentation": "

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

" } }, "com.amazonaws.transfer#CreateServerRequest": { @@ -1066,74 +1066,74 @@ "Certificate": { "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n

To request a new public certificate, see Request a public certificate\n in the Certificate Manager User Guide.

\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the Certificate Manager User Guide.

\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Certificate Manager User\n Guide.

\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\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

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": "

The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

" } }, "Domain": { "target": "com.amazonaws.transfer#Domain", "traits": { - "smithy.api#documentation": "

The domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.

\n \n

After the server is created, the domain cannot be changed.

\n " + "smithy.api#documentation": "

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

" } }, "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "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 your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

" + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\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 type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

" } }, "HostKey": { "target": "com.amazonaws.transfer#HostKey", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want\n to rotate keys, or have a set of active keys that use different algorithms.

\n

Use the following command to generate an RSA 2048 bit key with no passphrase:

\n

\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

\n

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

\n

Use the following command to generate an ECDSA 256 bit key with no passphrase:

\n

\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

\n

Valid values for the -b option for ECDSA are 256, 384, and 521.

\n

Use the following command to generate an ED25519 key with no passphrase:

\n

\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

\n

For all of these commands, you can replace my-new-server-key with a string of your choice.

\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

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" + "smithy.api#documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" } }, "IdentityProviderDetails": { "target": "com.amazonaws.transfer#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

Required when IdentityProviderType is set to\n AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or\n API_GATEWAY. Accepts an array containing all of the information required to use\n a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication\n API, including the API Gateway URL. Cannot be specified when IdentityProviderType\n is set to SERVICE_MANAGED.

" + "smithy.api#documentation": "

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when IdentityProviderType is set to SERVICE_MANAGED.

" } }, "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

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 Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#NullableRole", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

" } }, "PostAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

" } }, "PreAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

" } }, "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 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 AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    \n
    • \n
\n \n
    \n
  • \n

    If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) \n which is used to identify your server when clients connect to it over\n FTPS.

    \n
    • \n
  • \n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n
    • \n
  • \n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: \n SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes AS2, then the\n EndpointType must be VPC, and domain must be Amazon S3.

    \n
    • \n
\n " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

" } }, "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { - "smithy.api#documentation": "

The protocol settings that are configured for your server.

\n
    \n
  • \n

    \n To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n

    \n
    • \n
  • \n

    To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are \n uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the \n SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to \n ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family \n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT \n call.

    \n
    • \n
  • \n

    To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the \n TlsSessionResumptionMode parameter.

    \n
    • \n
  • \n

    \n As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    \n
    • \n
" + "smithy.api#documentation": "

The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

" } }, "SecurityPolicyName": { @@ -1151,19 +1151,19 @@ "WorkflowDetails": { "target": "com.amazonaws.transfer#WorkflowDetails", "traits": { - "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

\n

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a\n workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n while the file is still being uploaded.

" + "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

" } }, "StructuredLogDestinations": { "target": "com.amazonaws.transfer#StructuredLogDestinations", "traits": { - "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

\n

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

\n

\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n

\n

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n

\n

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n value for this parameter in an update-server call. For example:

\n

\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n

" + "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

" } }, "S3StorageOptions": { "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

\n

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } } }, @@ -1221,7 +1221,7 @@ "transfer:TagResource" ] }, - "smithy.api#documentation": "

Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n IdentityProviderType set to SERVICE_MANAGED. Using parameters for\n CreateUser, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's Identity and Access Management (IAM)\n role. You can also optionally add a session policy, and assign metadata with tags that can\n be used to group and search for users.

", + "smithy.api#documentation": "

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

", "smithy.api#idempotent": {} } }, @@ -1231,44 +1231,44 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock your user down\n to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the value the user\n should see for their home directory when they log in.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the value the user should see for their home directory when they log in.

The following is an Entry and Target pair example for chroot.

[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

\n

For session policies, 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

For an example of a session policy, see Example session\n policy.

\n

For more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.

\n " + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

" } }, "PosixProfile": { "target": "com.amazonaws.transfer#PosixProfile", "traits": { - "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID\n (Gid), and any secondary groups IDs (SecondaryGids), that controls\n your users' access to your Amazon EFS file systems. The POSIX permissions that are set on\n files and directories in Amazon EFS determine the level of access your users get when\n transferring files into and out of your Amazon EFS file systems.

" + "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

" } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

", "smithy.api#required": {} } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "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#documentation": "

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

", "smithy.api#required": {} } }, @@ -1276,19 +1276,19 @@ "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.

\n

The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element.

\n

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

\n
    \n
  • \n

    For RSA keys, the key type is ssh-rsa.

    \n
    • \n
  • \n

    For ED25519 keys, the key type is ssh-ed25519.

    \n
    • \n
  • \n

    For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.

    \n
    • \n
" + "smithy.api#documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

  • For RSA keys, the key type is ssh-rsa.

  • For ED25519 keys, the key type is ssh-ed25519.

  • For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

" } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "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": "

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

" } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

A unique string that identifies a user and is associated with a 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#documentation": "

A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

", "smithy.api#required": {} } } @@ -1365,14 +1365,14 @@ "IdentityProviderDetails": { "target": "com.amazonaws.transfer#WebAppIdentityProviderDetails", "traits": { - "smithy.api#documentation": "

You can provide a structure that contains the details for the identity provider to use with your web app.

", + "smithy.api#documentation": "

You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps.

", "smithy.api#required": {} } }, "AccessEndpoint": { "target": "com.amazonaws.transfer#WebAppAccessEndpoint", "traits": { - "smithy.api#documentation": "

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

" + "smithy.api#documentation": "

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL.

" } }, "WebAppUnits": { @@ -1386,6 +1386,12 @@ "traits": { "smithy.api#documentation": "

Key-value pairs that can be used to group and search for web apps.

" } + }, + "WebAppEndpointPolicy": { + "target": "com.amazonaws.transfer#WebAppEndpointPolicy", + "traits": { + "smithy.api#documentation": "

Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to FIPS.

" + } } }, "traits": { @@ -1441,7 +1447,7 @@ "transfer:TagResource" ] }, - "smithy.api#documentation": "

\n Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.\n After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.\n

" + "smithy.api#documentation": "

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

" } }, "com.amazonaws.transfer#CreateWorkflowRequest": { @@ -1456,20 +1462,20 @@ "Steps": { "target": "com.amazonaws.transfer#WorkflowSteps", "traits": { - "smithy.api#documentation": "

Specifies the details for the steps that are in the specified workflow.

\n

\n The TYPE specifies which of the following actions is being taken for this step.\n

\n
    \n
  • \n

    \n \n COPY\n - Copy the file to another location.

    \n
    • \n
  • \n

    \n \n CUSTOM\n - Perform a custom step with an Lambda function target.

    \n
    • \n
  • \n

    \n \n DECRYPT\n - Decrypt a file that was encrypted before it was uploaded.

    \n
    • \n
  • \n

    \n \n DELETE\n - Delete the file.

    \n
    • \n
  • \n

    \n \n TAG\n - Add a tag to the file.

    \n
    • \n
\n \n

\n Currently, copying and tagging are supported only on S3.\n

\n \n

For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID\n and path.

", + "smithy.api#documentation": "

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

Currently, copying and tagging are supported only on S3.

For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.

", "smithy.api#required": {} } }, "OnExceptionSteps": { "target": "com.amazonaws.transfer#WorkflowSteps", "traits": { - "smithy.api#documentation": "

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

\n \n

For custom steps, the Lambda function needs to send FAILURE to the call\n back API to kick off the exception steps. Additionally, if the Lambda does not send\n SUCCESS before it times out, the exception steps are executed.

\n " + "smithy.api#documentation": "

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the exception steps are executed.

" } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached\n to workflows for any purpose.

" + "smithy.api#documentation": "

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

" } } }, @@ -1559,7 +1565,7 @@ "SourceFileLocation": { "target": "com.amazonaws.transfer#SourceFileLocation", "traits": { - "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.

\n
    \n
  • \n

    To use the previous file as the input, enter ${previous.file}.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.

    \n
    • \n
  • \n

    To use the originally uploaded file location as input for this step, enter ${original.file}.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

" } } }, @@ -1625,19 +1631,19 @@ "SourceFileLocation": { "target": "com.amazonaws.transfer#SourceFileLocation", "traits": { - "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.

\n
    \n
  • \n

    To use the previous file as the input, enter ${previous.file}.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.

    \n
    • \n
  • \n

    To use the originally uploaded file location as input for this step, enter ${original.file}.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

" } }, "OverwriteExisting": { "target": "com.amazonaws.transfer#OverwriteExisting", "traits": { - "smithy.api#documentation": "

A flag that indicates whether to overwrite an existing file of the same name.\n The default is FALSE.

\n

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

\n
    \n
  • \n

    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

    \n
    • \n
  • \n

    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

    \n
    • \n
" + "smithy.api#documentation": "

A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

  • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

  • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

" } }, "DestinationFileLocation": { "target": "com.amazonaws.transfer#InputFileLocation", "traits": { - "smithy.api#documentation": "

Specifies the location for the file being decrypted. Use ${Transfer:UserName} or\n ${Transfer:UploadDate} in this field to parametrize the destination prefix by\n username or uploaded date.

\n
    \n
  • \n

    Set the value of DestinationFileLocation to\n ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket\n that is prefixed with the name of the Transfer Family user that uploaded the\n file.

    \n
    • \n
  • \n

    Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to \n an Amazon S3 bucket that is prefixed with the date of the upload.

    \n \n

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file\n is uploaded in UTC.

    \n     \n
    • \n
", + "smithy.api#documentation": "

Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

  • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

  • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
", "smithy.api#required": {} } } @@ -1669,7 +1675,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows you to delete the access specified in the ServerID and\n ExternalID parameters.

" + "smithy.api#documentation": "

Allows you to delete the access specified in the ServerID and ExternalID parameters.

" } }, "com.amazonaws.transfer#DeleteAccessRequest": { @@ -1685,7 +1691,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -1766,7 +1772,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the certificate that's specified in the CertificateId\n parameter.

", + "smithy.api#documentation": "

Deletes the certificate that's specified in the CertificateId parameter.

", "smithy.api#idempotent": {} } }, @@ -1878,6 +1884,16 @@ "smithy.api#input": {} } }, + "com.amazonaws.transfer#DeleteId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[0-9a-zA-Z./-]+$" + } + }, "com.amazonaws.transfer#DeleteProfile": { "type": "operation", "input": { @@ -1961,7 +1977,7 @@ "transfer:DeleteServer" ] }, - "smithy.api#documentation": "

Deletes the file transfer protocol-enabled server that you specify.

\n

No response returns from this operation.

", + "smithy.api#documentation": "

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

", "smithy.api#idempotent": {} } }, @@ -2015,7 +2031,7 @@ "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 file transfer protocol-enabled server instance that has the user assigned to it.

", "smithy.api#required": {} } }, @@ -2050,7 +2066,7 @@ "SourceFileLocation": { "target": "com.amazonaws.transfer#SourceFileLocation", "traits": { - "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.

\n
    \n
  • \n

    To use the previous file as the input, enter ${previous.file}.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.

    \n
    • \n
  • \n

    To use the originally uploaded file location as input for this step, enter ${original.file}.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

" } } }, @@ -2086,7 +2102,7 @@ "transfer:DeleteUser" ] }, - "smithy.api#documentation": "

Deletes the user belonging to a file transfer protocol-enabled server you specify.

\n

No response returns from this operation.

\n \n

When you delete a user from a server, the user's information is lost.

\n ", + "smithy.api#documentation": "

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

", "smithy.api#idempotent": {} } }, @@ -2096,7 +2112,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a server instance that has the user assigned to\n it.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a server instance that has the user assigned to it.

", "smithy.api#required": {} } }, @@ -2296,7 +2312,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.

\n

The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.

", + "smithy.api#documentation": "

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

", "smithy.api#readonly": {} } }, @@ -2313,7 +2329,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -2400,7 +2416,7 @@ "target": "com.amazonaws.transfer#DescribedAgreement", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The details for the specified agreement, returned as a DescribedAgreement\n object.

", + "smithy.api#documentation": "

The details for the specified agreement, returned as a DescribedAgreement object.

", "smithy.api#required": {} } } @@ -2490,7 +2506,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the connector that's identified by the ConnectorId.\n

", + "smithy.api#documentation": "

Describes the connector that's identified by the ConnectorId.

", "smithy.api#readonly": {} } }, @@ -2548,7 +2564,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use DescribeExecution to check the details of the execution of the specified workflow.

\n \n

This API call only returns details for in-progress workflows.

\n

\n If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a\n ResourceNotFound exception.

\n ", + "smithy.api#documentation": "

You can use DescribeExecution to check the details of the execution of the specified workflow.

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

", "smithy.api#readonly": {} } }, @@ -2741,7 +2757,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies for servers or Working with security\n policies for SFTP connectors.

", + "smithy.api#documentation": "

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

", "smithy.api#readonly": {} } }, @@ -2804,7 +2820,7 @@ "transfer:DescribeServer" ] }, - "smithy.api#documentation": "

Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.

\n

The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.

", + "smithy.api#documentation": "

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ServerOffline": { @@ -2884,7 +2900,7 @@ "target": "com.amazonaws.transfer#DescribedServer", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

An array containing the properties of a server with the ServerID you\n specified.

", + "smithy.api#documentation": "

An array containing the properties of a server with the ServerID you specified.

", "smithy.api#required": {} } } @@ -2921,7 +2937,7 @@ "transfer:DescribeUser" ] }, - "smithy.api#documentation": "

Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.

\n

The response from this call returns the properties of the user associated with the\n ServerId value that was specified.

", + "smithy.api#documentation": "

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

", "smithy.api#readonly": {} } }, @@ -2938,7 +2954,7 @@ "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "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 Transfer Family service and perform 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 credentials to use the Transfer Family service and perform file transfer tasks.

", "smithy.api#required": {} } } @@ -2961,7 +2977,7 @@ "target": "com.amazonaws.transfer#DescribedUser", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

An array containing the properties of the Transfer Family user for the ServerID value\n that you specified.

", + "smithy.api#documentation": "

An array containing the properties of the Transfer Family user for the ServerID value that you specified.

", "smithy.api#required": {} } } @@ -3179,25 +3195,25 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

In most cases, you can use this value instead of the session policy to lock down the\n associated access to the designated home directory (\"chroot\"). To do this, you\n can set Entry to '/' and set Target to the\n HomeDirectory parameter value.

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

" + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

" } }, "PosixProfile": { @@ -3206,13 +3222,13 @@ "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

" } }, "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

" } } }, @@ -3246,13 +3262,13 @@ "Status": { "target": "com.amazonaws.transfer#AgreementStatusType", "traits": { - "smithy.api#documentation": "

The current status of the agreement, either ACTIVE or\n INACTIVE.

" + "smithy.api#documentation": "

The current status of the agreement, either ACTIVE or INACTIVE.

" } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a server instance. This identifier indicates the\n specific server that the agreement uses.

" + "smithy.api#documentation": "

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

" } }, "LocalProfileId": { @@ -3270,13 +3286,13 @@ "BaseDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for files that are transferred by using the AS2\n protocol.

" + "smithy.api#documentation": "

The landing directory (folder) for files that are transferred by using the AS2 protocol.

" } }, "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

" + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

" } }, "Tags": { @@ -3288,19 +3304,19 @@ "PreserveFilename": { "target": "com.amazonaws.transfer#PreserveFilenameType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload\n filename when saving it.\n

\n
    \n
  • \n

    \n ENABLED: the filename provided by your trading parter is preserved when the file is saved.

    \n
    • \n
  • \n

    \n DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as\n described in File names and locations.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

  • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

  • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

" } }, "EnforceMessageSigning": { "target": "com.amazonaws.transfer#EnforceMessageSigningType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not unsigned messages from your trading partners will be accepted.\n

\n
    \n
  • \n

    \n ENABLED: Transfer Family rejects unsigned messages from your trading partner.

    \n
    • \n
  • \n

    \n DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not unsigned messages from your trading partners will be accepted.

  • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

  • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

" } }, "CustomDirectories": { "target": "com.amazonaws.transfer#CustomDirectoriesType", "traits": { - "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

\n
    \n
  • \n

    Failed files

    \n
    • \n
  • \n

    MDN files

    \n
    • \n
  • \n

    Payload files

    \n
    • \n
  • \n

    Status files

    \n
    • \n
  • \n

    Temporary files

    \n
    • \n
" + "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

  • Failed files

  • MDN files

  • Payload files

  • Status files

  • Temporary files

" } } }, @@ -3328,13 +3344,13 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

\n
    \n
  • \n

    \n SIGNING: For signing AS2 messages

    \n
    • \n
  • \n

    \n ENCRYPTION: For encrypting AS2 messages

    \n
    • \n
  • \n

    \n TLS: For securing AS2 communications sent over HTTPS

    \n
    • \n
" + "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

  • SIGNING: For signing AS2 messages

  • ENCRYPTION: For encrypting AS2 messages

  • TLS: For securing AS2 communications sent over HTTPS

" } }, "Status": { "target": "com.amazonaws.transfer#CertificateStatusType", "traits": { - "smithy.api#documentation": "

Currently, the only available status is ACTIVE: all other values are reserved for future use.

" + "smithy.api#documentation": "

A certificate's status can be either ACTIVE or INACTIVE.

You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

" } }, "Certificate": { @@ -3352,13 +3368,13 @@ "ActiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

" } }, "InactiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

" } }, "Serial": { @@ -3376,7 +3392,7 @@ "NotAfterDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

The final date that the certificate is\n valid.

" + "smithy.api#documentation": "

The final date that the certificate is valid.

" } }, "Type": { @@ -3433,13 +3449,13 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

" + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

" } }, "Tags": { @@ -3468,7 +3484,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the parameters for the connector, as identified by the\n ConnectorId.

" + "smithy.api#documentation": "

Describes the parameters for the connector, as identified by the ConnectorId.

" } }, "com.amazonaws.transfer#DescribedExecution": { @@ -3483,7 +3499,7 @@ "InitialFileLocation": { "target": "com.amazonaws.transfer#FileLocation", "traits": { - "smithy.api#documentation": "

A structure that describes the Amazon S3 or EFS file location.\n This is the file location when the execution begins: if the file is being copied,\n this is the initial (as opposed to destination) file location.

" + "smithy.api#documentation": "

A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

" } }, "ServiceMetadata": { @@ -3510,13 +3526,13 @@ "Status": { "target": "com.amazonaws.transfer#ExecutionStatus", "traits": { - "smithy.api#documentation": "

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.\n

" + "smithy.api#documentation": "

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

" } }, "Results": { "target": "com.amazonaws.transfer#ExecutionResults", "traits": { - "smithy.api#documentation": "

A structure that describes the execution results. This includes a list of the steps along with the details of each step,\n error type and message (if any), and the OnExceptionSteps structure.

" + "smithy.api#documentation": "

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

" } } }, @@ -3555,7 +3571,7 @@ "Type": { "target": "com.amazonaws.transfer#HostKeyType", "traits": { - "smithy.api#documentation": "

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the\n following values:

\n
    \n
  • \n

    \n ssh-rsa\n

    \n
    • \n
  • \n

    \n ssh-ed25519\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp256\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp384\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp521\n

    \n
    • \n
" + "smithy.api#documentation": "

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

  • ssh-rsa

  • ssh-ed25519

  • ecdsa-sha2-nistp256

  • ecdsa-sha2-nistp384

  • ecdsa-sha2-nistp521

" } }, "DateImported": { @@ -3620,13 +3636,13 @@ "ProfileType": { "target": "com.amazonaws.transfer#ProfileType", "traits": { - "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.

" + "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

" } }, "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the \n RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages\n sent from the partner. For outbound connectors, this is the AS2-To header for the\n AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

" + "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

" } }, "CertificateIds": { @@ -3652,7 +3668,7 @@ "Fips": { "target": "com.amazonaws.transfer#Fips", "traits": { - "smithy.api#documentation": "

Specifies whether this policy enables Federal Information Processing Standards (FIPS).\n This parameter applies to both server and connector security policies.

" + "smithy.api#documentation": "

Specifies whether this policy enables Federal Information Processing Standards (FIPS). This parameter applies to both server and connector security policies.

" } }, "SecurityPolicyName": { @@ -3665,31 +3681,31 @@ "SshCiphers": { "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy\n that is attached to the server or connector. This parameter applies to both server and\n connector security policies.

" + "smithy.api#documentation": "

Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

" } }, "SshKexs": { "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that\n is attached to the server or connector. This parameter applies to both server and connector\n security policies.

" + "smithy.api#documentation": "

Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

" } }, "SshMacs": { "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

Lists the enabled SSH message authentication code (MAC) encryption algorithms in the\n security policy that is attached to the server or connector. This parameter applies to both\n server and connector security policies.

" + "smithy.api#documentation": "

Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

" } }, "TlsCiphers": { "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the\n security policy that is attached to the server.

\n \n

This parameter only applies to security policies for servers.

\n " + "smithy.api#documentation": "

Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

This parameter only applies to security policies for servers.

" } }, "SshHostKeyAlgorithms": { "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

Lists the host key algorithms for the security policy.

\n \n

This parameter only applies to security policies for connectors.

\n " + "smithy.api#documentation": "

Lists the host key algorithms for the security policy.

This parameter only applies to security policies for connectors.

" } }, "Type": { @@ -3706,7 +3722,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the properties of a security policy that you specify. For more information\n about security policies, see Working with security\n policies for servers or Working with security\n policies for SFTP connectors.

" + "smithy.api#documentation": "

Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

" } }, "com.amazonaws.transfer#DescribedServer": { @@ -3725,83 +3741,83 @@ "target": "com.amazonaws.transfer#Certificate", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when\n Protocols is set to FTPS.

" + "smithy.api#documentation": "

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

" } }, "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The protocol settings that are configured for your server.

\n
    \n
  • \n

    \n To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n

    \n
    • \n
  • \n

    To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are \n uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the \n SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to \n ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family \n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT \n call.

    \n
    • \n
  • \n

    To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the \n TlsSessionResumptionMode parameter.

    \n
    • \n
  • \n

    \n As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    \n
    • \n
" + "smithy.api#documentation": "

The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

" } }, "Domain": { "target": "com.amazonaws.transfer#Domain", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Specifies the domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.

" + "smithy.api#documentation": "

Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

" } }, "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { "aws.cloudformation#cfnMutability": "full", - "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 your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

" + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { "aws.cloudformation#cfnMutability": "full", - "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.

" + "smithy.api#documentation": "

Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

" } }, "HostKeyFingerprint": { "target": "com.amazonaws.transfer#HostKeyFingerprint", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "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.

" + "smithy.api#documentation": "

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

" } }, "IdentityProviderDetails": { "target": "com.amazonaws.transfer#IdentityProviderDetails", "traits": { "aws.cloudformation#cfnMutability": "full", - "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 AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

" + "smithy.api#documentation": "

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

" } }, "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

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 Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#NullableRole", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

" } }, "PostAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

" } }, "PreAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

" } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", "traits": { "aws.cloudformation#cfnMutability": "full", - "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 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 AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    \n
    • \n
\n \n
    \n
  • \n

    If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) \n which is used to identify your server when clients connect to it over\n FTPS.

    \n
    • \n
  • \n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n
    • \n
  • \n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: \n SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes AS2, then the\n EndpointType must be VPC, and domain must be Amazon S3.

    \n
    • \n
\n " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

" } }, "SecurityPolicyName": { @@ -3821,54 +3837,54 @@ "target": "com.amazonaws.transfer#State", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The condition of 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

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": "

The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

" } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "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.

" + "smithy.api#documentation": "

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

" } }, "UserCount": { "target": "com.amazonaws.transfer#UserCount", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Specifies the number of users that are assigned to a server you specified with the\n ServerId.

" + "smithy.api#documentation": "

Specifies the number of users that are assigned to a server you specified with the ServerId.

" } }, "WorkflowDetails": { "target": "com.amazonaws.transfer#WorkflowDetails", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

\n

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a\n workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n while the file is still being uploaded.

" + "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

" } }, "StructuredLogDestinations": { "target": "com.amazonaws.transfer#StructuredLogDestinations", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

\n

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

\n

\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n

\n

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n

\n

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n value for this parameter in an update-server call. For example:

\n

\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n

" + "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

" } }, "S3StorageOptions": { "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

\n

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } }, "As2ServiceManagedEgressIpAddresses": { "target": "com.amazonaws.transfer#ServiceManagedEgressIpAddresses", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "

The list of egress IP addresses of this server. These IP addresses are only relevant\n for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

\n

These IP addresses are assigned automatically when you create an AS2 server. Additionally,\n if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

" + "smithy.api#documentation": "

The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the properties of a file transfer protocol-enabled server that was\n specified.

" + "smithy.api#documentation": "

Describes the properties of a file transfer protocol-enabled server that was specified.

" } }, "com.amazonaws.transfer#DescribedUser": { @@ -3879,7 +3895,7 @@ "traits": { "aws.cloudformation#cfnAdditionalIdentifier": {}, "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be\n described.

", + "smithy.api#documentation": "

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

", "smithy.api#required": {} } }, @@ -3887,62 +3903,62 @@ "target": "com.amazonaws.transfer#HomeDirectory", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

" + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

" } }, "PosixProfile": { "target": "com.amazonaws.transfer#PosixProfile", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID\n (Gid), and any secondary groups IDs (SecondaryGids), that controls\n your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX\n permissions that are set on files and directories in your file system determine the level of\n access your users get when transferring files into and out of your Amazon EFS file\n systems.

" + "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

" } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

" } }, "SshPublicKeys": { "target": "com.amazonaws.transfer#SshPublicKeys", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "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 public key portion of the Secure Shell (SSH) keys stored for the described user.

To delete the public key body, set its value to zero keys, as shown here:

SshPublicKeys: []

" } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "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 key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

" } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "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 server.

" + "smithy.api#documentation": "

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

" } } }, @@ -3996,6 +4012,12 @@ "traits": { "smithy.api#documentation": "

Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.

" } + }, + "WebAppEndpointPolicy": { + "target": "com.amazonaws.transfer#WebAppEndpointPolicy", + "traits": { + "smithy.api#documentation": "

Setting for the type of endpoint policy for the web app. The default value is STANDARD.

If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be FIPS, which indicates the web app endpoint is FIPS-compliant.

" + } } }, "traits": { @@ -4034,7 +4056,7 @@ "FaviconFile": { "target": "com.amazonaws.transfer#WebAppFaviconFile", "traits": { - "smithy.api#documentation": "

Returns a icon file data string (in base64 encoding).

" + "smithy.api#documentation": "

Returns an icon file data string (in base64 encoding).

" } } }, @@ -4181,7 +4203,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems\n (Amazon EFS) for storage.

\n

\n

" + "smithy.api#documentation": "

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.

" } }, "com.amazonaws.transfer#EfsFileSystemId": { @@ -4256,36 +4278,36 @@ "AddressAllocationIds": { "target": "com.amazonaws.transfer#AddressAllocationIds", "traits": { - "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

An address allocation ID corresponds to the allocation ID of an Elastic IP address. This\n value can be retrieved from the allocationId field from the Amazon EC2\n Address\n data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

\n

This parameter is optional. Set this parameter if you want to make your VPC endpoint\n public-facing. For details, see Create an internet-facing endpoint for your server.

\n \n

This property can only be set as follows:

\n
    \n
  • \n

    \n EndpointType must be set to\n VPC\n

    \n
    • \n
  • \n

    The Transfer Family server must be offline.

    \n
    • \n
  • \n

    You cannot set this parameter for Transfer Family servers that use the FTP protocol.

    \n
    • \n
  • \n

    The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).

    \n
    • \n
  • \n

    \n AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example,\n if you have three subnet IDs, you must also specify three address allocation IDs.

    \n
    • \n
  • \n

    Call the UpdateServer API to set or change this parameter.

    \n
    • \n
\n " + "smithy.api#documentation": "

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the allocationId field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.

This property can only be set as follows:

  • EndpointType must be set to VPC

  • The Transfer Family server must be offline.

  • You cannot set this parameter for Transfer Family servers that use the FTP protocol.

  • The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).

  • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example, if you have three subnet IDs, you must also specify three address allocation IDs.

  • Call the UpdateServer API to set or change this parameter.

" } }, "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

This property can only be set when EndpointType is set to\n VPC.

\n " + "smithy.api#documentation": "

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

" } }, "VpcEndpointId": { "target": "com.amazonaws.transfer#VpcEndpointId", "traits": { - "smithy.api#documentation": "

The identifier of the VPC endpoint.

\n \n

This property can only be set when EndpointType is set to\n VPC_ENDPOINT.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " + "smithy.api#documentation": "

The identifier of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

" } }, "VpcId": { "target": "com.amazonaws.transfer#VpcId", "traits": { - "smithy.api#documentation": "

The VPC identifier of the VPC in which a server's endpoint will be hosted.

\n \n

This property can only be set when EndpointType is set to\n VPC.

\n " + "smithy.api#documentation": "

The VPC identifier of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

" } }, "SecurityGroupIds": { "target": "com.amazonaws.transfer#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

A list of security groups IDs that are available to attach to your server's\n endpoint.

\n \n

This property can only be set when EndpointType is set to\n VPC.

\n

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from\n PUBLIC or VPC_ENDPOINT to VPC. To change security\n groups associated with your server's VPC endpoint after creation, use the Amazon EC2\n ModifyVpcEndpoint API.

\n " + "smithy.api#documentation": "

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

" } } }, "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 and resources only within your VPC. To control incoming internet traffic, invoke the\n UpdateServer API and attach an Elastic IP address to your server's\n endpoint.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\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 file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

" } }, "com.amazonaws.transfer#EndpointType": { @@ -4334,7 +4356,7 @@ "Type": { "target": "com.amazonaws.transfer#ExecutionErrorType", "traits": { - "smithy.api#documentation": "

Specifies the error type.

\n
    \n
  • \n

    \n ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

    \n
    • \n
  • \n

    \n BAD_REQUEST: a general bad request: for example, a step that attempts to\n tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

    \n
    • \n
  • \n

    \n CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

    \n
    • \n
  • \n

    \n INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of\n reasons.

    \n
    • \n
  • \n

    \n NOT_FOUND: occurs when a requested entity, for example a source file for\n a copy step, does not exist.

    \n
    • \n
  • \n

    \n PERMISSION_DENIED: occurs if your policy does not contain the correct\n permissions to complete one or more of the steps in the workflow.

    \n
    • \n
  • \n

    \n TIMEOUT: occurs when the execution times out.

    \n \n

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

    \n     \n
    • \n
  • \n

    \n THROTTLED: occurs if you exceed the new execution refill rate of one\n workflow per second.

    \n
    • \n
", + "smithy.api#documentation": "

Specifies the error type.

  • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

  • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

  • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

  • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

  • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

  • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

  • TIMEOUT: occurs when the execution times out.

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

  • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

", "smithy.api#required": {} } }, @@ -4471,7 +4493,7 @@ "StepType": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

One of the available step types.

\n
    \n
  • \n

    \n \n COPY\n - Copy the file to another location.

    \n
    • \n
  • \n

    \n \n CUSTOM\n - Perform a custom step with an Lambda function target.

    \n
    • \n
  • \n

    \n \n DECRYPT\n - Decrypt a file that was encrypted before it was uploaded.

    \n
    • \n
  • \n

    \n \n DELETE\n - Delete the file.

    \n
    • \n
  • \n

    \n \n TAG\n - Add a tag to the file.

    \n
    • \n
" + "smithy.api#documentation": "

One of the available step types.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

" } }, "Outputs": { @@ -4483,7 +4505,7 @@ "Error": { "target": "com.amazonaws.transfer#ExecutionError", "traits": { - "smithy.api#documentation": "

Specifies the details for an error, if it occurred during execution of the specified\n workflow step.

" + "smithy.api#documentation": "

Specifies the details for an error, if it occurred during execution of the specified workflow step.

" } } }, @@ -4522,7 +4544,7 @@ "S3FileLocation": { "target": "com.amazonaws.transfer#S3FileLocation", "traits": { - "smithy.api#documentation": "

Specifies the S3 details for the file being used, such as bucket, ETag, and so\n forth.

" + "smithy.api#documentation": "

Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.

" } }, "EfsFileLocation": { @@ -4601,12 +4623,12 @@ "Type": { "target": "com.amazonaws.transfer#MapType", "traits": { - "smithy.api#documentation": "

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

\n \n

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly\n set Type to FILE if you want a mapping to have a file\n target.

\n " + "smithy.api#documentation": "

Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

" } } }, "traits": { - "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

" } }, "com.amazonaws.transfer#HomeDirectoryMappings": { @@ -4726,7 +4748,7 @@ "InvocationRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user\n account.

" + "smithy.api#documentation": "

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

" } }, "DirectoryId": { @@ -4744,12 +4766,12 @@ "SftpAuthenticationMethods": { "target": "com.amazonaws.transfer#SftpAuthenticationMethods", "traits": { - "smithy.api#documentation": "

For SFTP-enabled servers, and for custom identity providers only, you\n can specify whether to authenticate using a password, SSH key pair, or both.

\n
    \n
  • \n

    \n PASSWORD - users must provide their password to connect.

    \n
    • \n
  • \n

    \n PUBLIC_KEY - users must provide their private key to connect.

    \n
    • \n
  • \n

    \n PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

    \n
    • \n
  • \n

    \n PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect.\n The server checks the key first, and then if the key is valid, the system prompts for a password. \n If the private key provided does not match the public key that is stored, authentication fails.

    \n
    • \n
" + "smithy.api#documentation": "

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

  • PASSWORD - users must provide their password to connect.

  • PUBLIC_KEY - users must provide their private key to connect.

  • PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

  • PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

" } } }, "traits": { - "smithy.api#documentation": "

Returns information related to the type of user authentication that is in use for a file\n transfer protocol-enabled server's users. A server can have only one method of\n authentication.

" + "smithy.api#documentation": "

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

" } }, "com.amazonaws.transfer#IdentityProviderType": { @@ -4781,7 +4803,7 @@ } }, "traits": { - "smithy.api#documentation": "

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 Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "com.amazonaws.transfer#ImportCertificate": { @@ -4812,7 +4834,7 @@ "transfer:TagResource" ] }, - "smithy.api#documentation": "

Imports the signing and encryption certificates that you need to create local (AS2)\n profiles and partner\n profiles.

" + "smithy.api#documentation": "

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

You can import both the certificate and its chain in the Certificate parameter.

If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

" } }, "com.amazonaws.transfer#ImportCertificateRequest": { @@ -4821,39 +4843,39 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

\n
    \n
  • \n

    \n SIGNING: For signing AS2 messages

    \n
    • \n
  • \n

    \n ENCRYPTION: For encrypting AS2 messages

    \n
    • \n
  • \n

    \n TLS: For securing AS2 communications sent over HTTPS

    \n
    • \n
", + "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

  • SIGNING: For signing AS2 messages

  • ENCRYPTION: For encrypting AS2 messages

  • TLS: For securing AS2 communications sent over HTTPS

", "smithy.api#required": {} } }, "Certificate": { "target": "com.amazonaws.transfer#CertificateBodyType", "traits": { - "smithy.api#documentation": "
    \n
  • \n

    For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem.\n Alternatively, you can provide the raw content.

    \n
    • \n
  • \n

    For the SDK, specify the raw content of a certificate file. For example, --certificate \"`cat encryption-cert.pem`\".

    \n
    • \n
", + "smithy.api#documentation": "

  • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

  • For the SDK, specify the raw content of a certificate file. For example, --certificate \"`cat encryption-cert.pem`\".

You can provide both the certificate and its chain in this parameter, without needing to use the CertificateChain parameter. If you use this parameter for both the certificate and its chain, do not use the CertificateChain parameter.

", "smithy.api#required": {} } }, "CertificateChain": { "target": "com.amazonaws.transfer#CertificateChainType", "traits": { - "smithy.api#documentation": "

An optional list of certificates that make up the chain for the certificate that's being\n imported.

" + "smithy.api#documentation": "

An optional list of certificates that make up the chain for the certificate that's being imported.

" } }, "PrivateKey": { "target": "com.amazonaws.transfer#PrivateKeyType", "traits": { - "smithy.api#documentation": "
    \n
  • \n

    For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem.\n Alternatively, you can provide the raw content of the private key file.

    \n
    • \n
  • \n

    For the SDK, specify the raw content of a private key file. For example, --private-key \"`cat encryption-key.pem`\"\n

    \n
    • \n
" + "smithy.api#documentation": "

  • For the CLI, provide a file path for a private key in URI format. For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

  • For the SDK, specify the raw content of a private key file. For example, --private-key \"`cat encryption-key.pem`\"

" } }, "ActiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

" } }, "InactiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

" } }, "Description": { @@ -4917,7 +4939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a host key to the server that's specified by the ServerId\n parameter.

" + "smithy.api#documentation": "

Adds a host key to the server that's specified by the ServerId parameter.

" } }, "com.amazonaws.transfer#ImportHostKeyRequest": { @@ -4933,7 +4955,7 @@ "HostKeyBody": { "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "

The private key portion of an SSH key pair.

\n

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", + "smithy.api#documentation": "

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", "smithy.api#required": {} } }, @@ -5005,7 +5027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a\n UserName value assigned to the specific file transfer protocol-enabled server,\n identified by ServerId.

\n

The response returns the UserName value, the ServerId value, and\n the name of the SshPublicKeyId.

" + "smithy.api#documentation": "

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

" } }, "com.amazonaws.transfer#ImportSshPublicKeyRequest": { @@ -5021,7 +5043,7 @@ "SshPublicKeyBody": { "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { - "smithy.api#documentation": "

The public key portion of an SSH key pair.

\n

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", + "smithy.api#documentation": "

The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", "smithy.api#required": {} } }, @@ -5063,7 +5085,7 @@ } }, "traits": { - "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.

", + "smithy.api#documentation": "

Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

", "smithy.api#output": {} } }, @@ -5079,7 +5101,7 @@ "EfsFileLocation": { "target": "com.amazonaws.transfer#EfsFileLocation", "traits": { - "smithy.api#documentation": "

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being\n decrypted.

" + "smithy.api#documentation": "

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

" } } }, @@ -5183,7 +5205,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When you can get additional results from the ListAccesses 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 accesses.

" + "smithy.api#documentation": "

When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

" } }, "ServerId": { @@ -5204,7 +5226,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When you can get additional results from the ListAccesses 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 accesses.

" + "smithy.api#documentation": "

When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

" } }, "ServerId": { @@ -5217,7 +5239,7 @@ "Accesses": { "target": "com.amazonaws.transfer#ListedAccesses", "traits": { - "smithy.api#documentation": "

Returns the accesses and their properties for the ServerId value that you\n specify.

", + "smithy.api#documentation": "

Returns the accesses and their properties for the ServerId value that you specify.

", "smithy.api#required": {} } } @@ -5252,7 +5274,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the agreements for the server that's identified by the\n ServerId that you supply. If you want to limit the results to a certain number,\n supply a value for the MaxResults parameter. If you ran the command previously\n and received a value for NextToken, you can supply that value to continue listing\n agreements from where you left off.

", + "smithy.api#documentation": "

Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5274,7 +5296,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When you can get additional results from the ListAgreements 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 agreements.

" + "smithy.api#documentation": "

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

" } }, "ServerId": { @@ -5295,7 +5317,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns a token that you can use to call ListAgreements again and receive\n additional results, if there are any.

" + "smithy.api#documentation": "

Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

" } }, "Agreements": { @@ -5336,7 +5358,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the current certificates that have been imported into Transfer Family. If you want to\n limit the results to a certain number, supply a value for the MaxResults\n parameter. If you ran the command previously and received a value for the\n NextToken parameter, you can supply that value to continue listing certificates\n from where you left off.

", + "smithy.api#documentation": "

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5358,7 +5380,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When you can get additional results from the ListCertificates 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 certificates.

" + "smithy.api#documentation": "

When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

" } } }, @@ -5378,7 +5400,7 @@ "Certificates": { "target": "com.amazonaws.transfer#ListedCertificates", "traits": { - "smithy.api#documentation": "

Returns an array of the certificates that are specified in the\n ListCertificates call.

", + "smithy.api#documentation": "

Returns an array of the certificates that are specified in the ListCertificates call.

", "smithy.api#required": {} } } @@ -5435,7 +5457,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When you can get additional results from the ListConnectors 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 connectors.

" + "smithy.api#documentation": "

When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.

" } } }, @@ -5449,7 +5471,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns a token that you can use to call ListConnectors again and receive\n additional results, if there are any.

" + "smithy.api#documentation": "

Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

" } }, "Connectors": { @@ -5490,7 +5512,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all in-progress executions for the specified workflow.

\n \n

If the specified workflow ID cannot be found, ListExecutions returns a \n ResourceNotFound exception.

\n ", + "smithy.api#documentation": "

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5512,7 +5534,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.

\n

\n This is useful for pagination, for instance.\n If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:\n

\n

\n aws transfer list-executions --max-results 10\n

\n

\n This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution.\n You can now call the API again, supplying the NextToken value you received:\n

\n

\n aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult\n

\n

\n This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details\n for all 100 executions have been returned.\n

" + "smithy.api#documentation": "

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

" } }, "WorkflowId": { @@ -5533,7 +5555,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

\n ListExecutions returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional executions.

" + "smithy.api#documentation": "

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

" } }, "WorkflowId": { @@ -5578,7 +5600,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. \n You specify the file transfer by providing its ConnectorId and its TransferId.

\n \n

File transfer results are available up to 7 days after an operation has been requested.

\n ", + "smithy.api#documentation": "

Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId.

File transfer results are available up to 7 days after an operation has been requested.

", "smithy.api#http": { "method": "POST", "uri": "/listFileTransferResults" @@ -5617,7 +5639,7 @@ "MaxResults": { "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single\n StartFileTransfer operation. Thus, the maximum\n number of file transfer results that can be returned in a single page is 10.\n

" + "smithy.api#documentation": "

The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single StartFileTransfer operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10.

" } } }, @@ -5631,14 +5653,14 @@ "FileTransferResults": { "target": "com.amazonaws.transfer#ConnectorFileTransferResults", "traits": { - "smithy.api#documentation": "

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

\n
    \n
  • \n

    \n FilePath: the filename and path to where the file was sent to or retrieved from.

    \n
    • \n
  • \n

    \n StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED,\n IN_PROGRESS, COMPLETED, or FAILED\n

    \n
    • \n
  • \n

    \n FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND\n

    \n
    • \n
  • \n

    \n FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

    \n
    • \n
", + "smithy.api#documentation": "

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

  • FilePath: the filename and path to where the file was sent to or retrieved from.

  • StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED, IN_PROGRESS, COMPLETED, or FAILED

  • FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

  • FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns a token that you can use to call ListFileTransferResults again and receive\n additional results, if there are any (against the same TransferId.

" + "smithy.api#documentation": "

Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

" } } }, @@ -5672,7 +5694,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of host keys for the server that's specified by the ServerId\n parameter.

", + "smithy.api#documentation": "

Returns a list of host keys for the server that's specified by the ServerId parameter.

", "smithy.api#readonly": {} } }, @@ -5688,7 +5710,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When there are additional results that were not returned, a NextToken\n parameter is returned. You can use that value for a subsequent call to\n ListHostKeys to continue listing results.

" + "smithy.api#documentation": "

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

" } }, "ServerId": { @@ -5709,7 +5731,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns a token that you can use to call ListHostKeys again and receive\n additional results, if there are any.

" + "smithy.api#documentation": "

Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

" } }, "ServerId": { @@ -5757,7 +5779,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the profiles for your system. If you want to limit the results to a\n certain number, supply a value for the MaxResults parameter. If you ran the\n command previously and received a value for NextToken, you can supply that value\n to continue listing profiles from where you left off.

", + "smithy.api#documentation": "

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5779,13 +5801,13 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

When there are additional results that were not returned, a NextToken\n parameter is returned. You can use that value for a subsequent call to\n ListProfiles to continue listing results.

" + "smithy.api#documentation": "

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

" } }, "ProfileType": { "target": "com.amazonaws.transfer#ProfileType", "traits": { - "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.

" + "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

" } } }, @@ -5799,7 +5821,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns a token that you can use to call ListProfiles again and receive\n additional results, if there are any.

" + "smithy.api#documentation": "

Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

" } }, "Profiles": { @@ -5837,7 +5859,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the security policies that are attached to your servers and SFTP connectors. For more information\n about security policies, see Working with security\n policies for servers or Working with security\n policies for SFTP connectors.

", + "smithy.api#documentation": "

Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5853,13 +5875,13 @@ "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.

" + "smithy.api#documentation": "

Specifies the number of security policies to return as a response to the ListSecurityPolicies query.

" } }, "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.

" + "smithy.api#documentation": "

When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

" } } }, @@ -5873,7 +5895,7 @@ "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.

" + "smithy.api#documentation": "

When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

" } }, "SecurityPolicyNames": { @@ -5916,7 +5938,7 @@ "transfer:ListServers" ] }, - "smithy.api#documentation": "

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services\n account.

", + "smithy.api#documentation": "

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5932,13 +5954,13 @@ "MaxResults": { "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of servers to return as a response to the ListServers\n query.

" + "smithy.api#documentation": "

Specifies the number of servers to return as a response to the ListServers query.

" } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "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.

" + "smithy.api#documentation": "

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

" } } }, @@ -5952,7 +5974,7 @@ "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 servers.

" + "smithy.api#documentation": "

When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

" } }, "Servers": { @@ -5990,7 +6012,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The\n resource can be a user, server, or role.

", + "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6006,20 +6028,20 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an\n identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", + "smithy.api#documentation": "

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", "smithy.api#required": {} } }, "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.

" + "smithy.api#documentation": "

Specifies the number of tags to return as a response to the ListTagsForResource request.

" } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "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.

" + "smithy.api#documentation": "

When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

" } } }, @@ -6039,13 +6061,13 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "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": "

When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

" } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "traits": { - "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.

" + "smithy.api#documentation": "

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

" } } }, @@ -6084,7 +6106,7 @@ "transfer:ListUsers" ] }, - "smithy.api#documentation": "

Lists the users for a file transfer protocol-enabled server that you specify by passing\n the ServerId parameter.

", + "smithy.api#documentation": "

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6100,13 +6122,13 @@ "MaxResults": { "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the number of users to return as a response to the ListUsers\n request.

" + "smithy.api#documentation": "

Specifies the number of users to return as a response to the ListUsers request.

" } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

If there are additional results from the ListUsers call, a\n NextToken parameter is returned in the output. You can then pass \n the NextToken to a subsequent ListUsers command, to continue listing additional\n users.

" + "smithy.api#documentation": "

If there are additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass the NextToken to a subsequent ListUsers command, to continue listing additional users.

" } }, "ServerId": { @@ -6127,7 +6149,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "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.

" + "smithy.api#documentation": "

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

" } }, "ServerId": { @@ -6140,7 +6162,7 @@ "Users": { "target": "com.amazonaws.transfer#ListedUsers", "traits": { - "smithy.api#documentation": "

Returns the Transfer Family users and their properties for the ServerId value that\n you specify.

", + "smithy.api#documentation": "

Returns the Transfer Family users and their properties for the ServerId value that you specify.

", "smithy.api#required": {} } } @@ -6203,7 +6225,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional web apps.

" + "smithy.api#documentation": "

Returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional web apps.

" } } }, @@ -6217,7 +6239,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

Provide this value for the NextToken parameter in a subsequent command to\n continue listing additional web apps.

" + "smithy.api#documentation": "

Provide this value for the NextToken parameter in a subsequent command to continue listing additional web apps.

" } }, "WebApps": { @@ -6277,7 +6299,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.

" + "smithy.api#documentation": "

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

" } } }, @@ -6291,7 +6313,7 @@ "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

\n ListWorkflows returns the NextToken parameter in the output.\n You can then pass the NextToken parameter in a subsequent command to\n continue listing additional workflows.

" + "smithy.api#documentation": "

ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

" } }, "Workflows": { @@ -6312,25 +6334,25 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

" } }, "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

" } } }, @@ -6362,7 +6384,7 @@ "Description": { "target": "com.amazonaws.transfer#Description", "traits": { - "smithy.api#documentation": "

The current description for the agreement. You can change it by calling the\n UpdateAgreement operation and providing a new description.

" + "smithy.api#documentation": "

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

" } }, "Status": { @@ -6418,31 +6440,31 @@ "Usage": { "target": "com.amazonaws.transfer#CertificateUsageType", "traits": { - "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

\n
    \n
  • \n

    \n SIGNING: For signing AS2 messages

    \n
    • \n
  • \n

    \n ENCRYPTION: For encrypting AS2 messages

    \n
    • \n
  • \n

    \n TLS: For securing AS2 communications sent over HTTPS

    \n
    • \n
" + "smithy.api#documentation": "

Specifies how this certificate is used. It can be used in the following ways:

  • SIGNING: For signing AS2 messages

  • ENCRYPTION: For encrypting AS2 messages

  • TLS: For securing AS2 communications sent over HTTPS

" } }, "Status": { "target": "com.amazonaws.transfer#CertificateStatusType", "traits": { - "smithy.api#documentation": "

The certificate can be either ACTIVE, PENDING_ROTATION, or\n INACTIVE. PENDING_ROTATION means that this certificate will\n replace the current certificate when it expires.

" + "smithy.api#documentation": "

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

" } }, "ActiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

" } }, "InactiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

" } }, "Type": { "target": "com.amazonaws.transfer#CertificateType", "traits": { - "smithy.api#documentation": "

The type for the certificate. If a private key has been specified for the certificate, its\n type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is\n CERTIFICATE.

" + "smithy.api#documentation": "

The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

" } }, "Description": { @@ -6506,7 +6528,7 @@ "InitialFileLocation": { "target": "com.amazonaws.transfer#FileLocation", "traits": { - "smithy.api#documentation": "

A structure that describes the Amazon S3 or EFS file location.\n This is the file location when the execution begins: if the file is being copied,\n this is the initial (as opposed to destination) file location.

" + "smithy.api#documentation": "

A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

" } }, "ServiceMetadata": { @@ -6563,7 +6585,7 @@ "Type": { "target": "com.amazonaws.transfer#HostKeyType", "traits": { - "smithy.api#documentation": "

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the\n following values:

\n
    \n
  • \n

    \n ssh-rsa\n

    \n
    • \n
  • \n

    \n ssh-ed25519\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp256\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp384\n

    \n
    • \n
  • \n

    \n ecdsa-sha2-nistp521\n

    \n
    • \n
" + "smithy.api#documentation": "

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

  • ssh-rsa

  • ssh-ed25519

  • ecdsa-sha2-nistp256

  • ecdsa-sha2-nistp384

  • ecdsa-sha2-nistp521

" } }, "DateImported": { @@ -6601,13 +6623,13 @@ "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the \n RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages\n sent from the partner. For outbound connectors, this is the AS2-To header for the\n AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

" + "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

" } }, "ProfileType": { "target": "com.amazonaws.transfer#ProfileType", "traits": { - "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. \n If not supplied in the request, the command lists all types of profiles.

" + "smithy.api#documentation": "

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

" } } }, @@ -6634,25 +6656,25 @@ "Domain": { "target": "com.amazonaws.transfer#Domain", "traits": { - "smithy.api#documentation": "

Specifies the domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.

" + "smithy.api#documentation": "

Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

" } }, "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

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 Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to\n provide a Directory ID by using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call\n for authentication by using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. \n If you choose this value, you must specify the ARN for the Lambda function in the Function parameter \n for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "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 internet.

" + "smithy.api#documentation": "

Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

" } }, "ServerId": { @@ -6664,13 +6686,13 @@ "State": { "target": "com.amazonaws.transfer#State", "traits": { - "smithy.api#documentation": "

The condition of 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

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": "

The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

" } }, "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.

" + "smithy.api#documentation": "

Specifies the number of users that are assigned to a server you specified with the ServerId.

" } } }, @@ -6690,26 +6712,26 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn\n about.

", + "smithy.api#documentation": "

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

", "smithy.api#required": {} } }, "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

\n \n

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS. \n

\n

The policies attached to this role determine the level of access you want to provide your users when \n transferring files into and out of your S3 buckets or EFS file systems.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

" } }, "SshPublicKeyCount": { @@ -6721,7 +6743,7 @@ "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

Specifies the name of the user whose ARN was specified. User names are used for\n authentication purposes.

" + "smithy.api#documentation": "

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

" } } }, @@ -6798,7 +6820,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the identifier, text description, and Amazon Resource Name (ARN) for the\n workflow.

" + "smithy.api#documentation": "

Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.

" } }, "com.amazonaws.transfer#ListedWorkflows": { @@ -6833,7 +6855,7 @@ "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

" } }, "LogGroupName": { @@ -6884,6 +6906,16 @@ } } }, + "com.amazonaws.transfer#MaxConcurrentConnections": { + "type": "integer", + "traits": { + "smithy.api#default": 1, + "smithy.api#documentation": "The number of concurrent connections that the connector will create to the remote server.", + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.transfer#MaxItems": { "type": "integer", "traits": { @@ -6973,6 +7005,16 @@ "smithy.api#pattern": "^[\\p{Print}\\p{Blank}]+$" } }, + "com.amazonaws.transfer#MoveId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[0-9a-zA-Z./-]+$" + } + }, "com.amazonaws.transfer#NextToken": { "type": "string", "traits": { @@ -7095,7 +7137,7 @@ } }, "traits": { - "smithy.api#documentation": "

The full POSIX identity, including user ID (Uid), group ID\n (Gid), and any secondary groups IDs (SecondaryGids), that controls\n your users' access to your Amazon EFS file systems. The POSIX permissions that are set on\n files and directories in your file system determine the level of access your users get when\n transferring files into and out of your Amazon EFS file systems.

" + "smithy.api#documentation": "

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

" } }, "com.amazonaws.transfer#PostAuthenticationLoginBanner": { @@ -7262,19 +7304,19 @@ "PassiveIp": { "target": "com.amazonaws.transfer#PassiveIp", "traits": { - "smithy.api#documentation": "

\n Indicates passive mode, for FTP and FTPS protocols.\n Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.\n For example:\n

\n

\n aws transfer update-server --protocol-details PassiveIp=0.0.0.0\n

\n

Replace 0.0.0.0 in the example above with the actual IP address you want to use.

\n \n

\n If you change the PassiveIp value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.\n

\n \n

\n Special values\n

\n

The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO\n is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response.\n PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment,\n where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability.\n In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their\n connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other\n clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

" + "smithy.api#documentation": "

Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:

aws transfer update-server --protocol-details PassiveIp=0.0.0.0

Replace 0.0.0.0 in the example above with the actual IP address you want to use.

If you change the PassiveIp value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.

Special values

The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

" } }, "TlsSessionResumptionMode": { "target": "com.amazonaws.transfer#TlsSessionResumptionMode", "traits": { - "smithy.api#documentation": "

A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret\n key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent,\n negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls.\n If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

\n
    \n
  • \n

    \n DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.

    \n
    • \n
  • \n

    \n ENABLED: the server processes and accepts clients that are performing TLS session resumption.\n The server doesn't reject client data connections that do not perform the TLS session resumption client processing.

    \n
    • \n
  • \n

    \n ENFORCED: the server processes and accepts clients that are performing TLS session resumption.\n The server rejects client data connections that do not perform the TLS session resumption client processing.\n Before you set the value to ENFORCED, test your clients.

    \n \n

    Not all FTPS clients perform TLS session resumption. So, if you choose to enforce\n TLS session resumption, you prevent any connections from FTPS clients that don't perform\n the protocol negotiation. To determine whether or not you can use the\n ENFORCED value, you need to test your clients.

    \n     \n
    • \n
" + "smithy.api#documentation": "

A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

  • DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.

  • ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.

  • ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

    Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.
" } }, "SetStatOption": { "target": "com.amazonaws.transfer#SetStatOption", "traits": { - "smithy.api#documentation": "

Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

\n

Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file.\n However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when \n the file is otherwise successfully uploaded.

\n

Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n While the SetStatOption\n ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

\n \n

If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.

\n " + "smithy.api#documentation": "

Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.

" } }, "As2Transports": { @@ -7285,7 +7327,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

" + "smithy.api#documentation": "

The protocol settings that are configured for your server.

" } }, "com.amazonaws.transfer#Protocols": { @@ -7354,7 +7396,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family\n service.

", + "smithy.api#documentation": "

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7447,7 +7489,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

\n

\n You need to provide the bucket and key.\n The key can represent either a path or a file.\n This is determined by whether or not you end the key value with the forward slash (/) character.\n If the final character is \"/\", then your file is copied to the folder, and its name does not change.\n If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.\n

\n

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder.\n If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today:\n each upload overwrites the previous version of the bob file.

" + "smithy.api#documentation": "

Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is \"/\", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

" } }, "com.amazonaws.transfer#S3Key": { @@ -7466,7 +7508,7 @@ "DirectoryListingOptimization": { "target": "com.amazonaws.transfer#DirectoryListingOptimization", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

\n

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } } }, @@ -7681,7 +7723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a callback for asynchronous custom steps.

\n

\n The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow.\n You must include those with their callback as well as providing a status.\n

" + "smithy.api#documentation": "

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

" } }, "com.amazonaws.transfer#SendWorkflowStepStateRequest": { @@ -7886,18 +7928,48 @@ "UserSecretId": { "target": "com.amazonaws.transfer#SecretId", "traits": { - "smithy.api#documentation": "

The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.

" + "smithy.api#documentation": "

The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.

  • Required when creating an SFTP connector

  • Optional when updating an existing SFTP connector

" } }, "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "

The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

\n

The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.

\n

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

\n
    \n
  • \n

    For RSA keys, the <key type> string is ssh-rsa.

    \n
    • \n
  • \n

    For ECDSA keys, the <key type> string is either\n ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.

    \n
    • \n
\n

Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.

\n

\n ssh-keyscan ftp.host.com\n

\n

This prints the public host key to standard output.

\n

\n ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key\n

\n

Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

" + "smithy.api#documentation": "

The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

TrustedHostKeys is optional for CreateConnector. If not provided, you can use TestConnection to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key.

The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

  • For RSA keys, the <key type> string is ssh-rsa.

  • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.

ssh-keyscan ftp.host.com

This prints the public host key to standard output.

ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key

Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

" + } + }, + "MaxConcurrentConnections": { + "target": "com.amazonaws.transfer#MaxConcurrentConnections", + "traits": { + "smithy.api#default": 1, + "smithy.api#documentation": "

Specify the number of concurrent connections that your connector creates to the remote server. The default value is 5 (this is also the maximum value allowed).

This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a\n partner's SFTP server.

\n \n

Because the SftpConnectorConfig data type is used for both creating and updating SFTP connectors, its parameters,\n TrustedHostKeys and UserSecretId are marked as not required. This is a bit misleading, as they are not required when\n you are updating an existing SFTP connector, but are required when you are creating a new SFTP connector.

\n " + "smithy.api#documentation": "

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

" + } + }, + "com.amazonaws.transfer#SftpConnectorConnectionDetails": { + "type": "structure", + "members": { + "HostKey": { + "target": "com.amazonaws.transfer#SftpConnectorHostKey", + "traits": { + "smithy.api#documentation": "

The SSH public key of the remote SFTP server. This is returned during the initial connection attempt when you call TestConnection. It allows you to retrieve the valid server host key to update the connector when you are unable to obtain it in advance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an SFTP connector connection.

" + } + }, + "com.amazonaws.transfer#SftpConnectorHostKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } } }, "com.amazonaws.transfer#SftpConnectorTrustedHostKey": { @@ -7916,7 +7988,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 10 } } @@ -7989,20 +8061,20 @@ "SshPublicKeyBody": { "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { - "smithy.api#documentation": "

Specifies the content of the SSH public key as specified by the\n PublicKeyId.

\n

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", + "smithy.api#documentation": "

Specifies the content of the SSH public key as specified by the PublicKeyId.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

", "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#documentation": "

Specifies the SshPublicKeyId parameter contains the identifier of the public key.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family\n user for the specific file transfer protocol-enabled server (as identified by\n ServerId). The information returned includes the date the key was imported, the\n public key contents, and the public key ID. A user can store more than one SSH public key\n associated with their user name on a specific server.

" + "smithy.api#documentation": "

Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

" } }, "com.amazonaws.transfer#SshPublicKeyBody": { @@ -8066,7 +8138,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the contents of a directory from a remote SFTP server. You specify the\n connector ID, the output path, and the remote directory path. You can also specify the\n optional MaxItems value to control the maximum number of items that are listed\n from the remote directory. This API returns a list of all files and directories in the remote\n directory (up to the maximum value), but does not return files or folders in sub-directories.\n That is, it only returns a list of files and directories one-level deep.

\n

After you receive the listing file, you can provide the files that you want to transfer to\n the RetrieveFilePaths parameter of the StartFileTransfer API\n call.

\n

The naming convention for the output file is\n \n connector-ID-listing-ID.json. The\n output file contains the following information:

\n
    \n
  • \n

    \n filePath: the complete path of a remote file, relative to the directory\n of the listing request for your SFTP connector on the remote server.

    \n
    • \n
  • \n

    \n modifiedTimestamp: the last time the file was modified, in UTC time\n format. This field is optional. If the remote file attributes don't contain a timestamp,\n it is omitted from the file listing.

    \n
    • \n
  • \n

    \n size: the size of the file, in bytes. This field is optional. If the\n remote file attributes don't contain a file size, it is omitted from the file\n listing.

    \n
    • \n
  • \n

    \n path: the complete path of a remote directory, relative to the directory\n of the listing request for your SFTP connector on the remote server.

    \n
    • \n
  • \n

    \n truncated: a flag indicating whether the list output contains all of the\n items contained in the remote directory or not. If your Truncated output\n value is true, you can increase the value provided in the optional max-items\n input attribute to be able to list more items (up to the maximum allowed list size of\n 10,000 items).

    \n
    • \n
" + "smithy.api#documentation": "

Retrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory (up to the maximum value), but does not return files or folders in sub-directories. That is, it only returns a list of files and directories one-level deep.

After you receive the listing file, you can provide the files that you want to transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call.

The naming convention for the output file is connector-ID-listing-ID.json. The output file contains the following information:

  • filePath: the complete path of a remote file, relative to the directory of the listing request for your SFTP connector on the remote server.

  • modifiedTimestamp: the last time the file was modified, in UTC time format. This field is optional. If the remote file attributes don't contain a timestamp, it is omitted from the file listing.

  • size: the size of the file, in bytes. This field is optional. If the remote file attributes don't contain a file size, it is omitted from the file listing.

  • path: the complete path of a remote directory, relative to the directory of the listing request for your SFTP connector on the remote server.

  • truncated: a flag indicating whether the list output contains all of the items contained in the remote directory or not. If your Truncated output value is true, you can increase the value provided in the optional max-items input attribute to be able to list more items (up to the maximum allowed list size of 10,000 items).

" } }, "com.amazonaws.transfer#StartDirectoryListingRequest": { @@ -8089,7 +8161,7 @@ "MaxItems": { "target": "com.amazonaws.transfer#MaxItems", "traits": { - "smithy.api#documentation": "

An optional parameter where you can specify the maximum number of file/directory names to\n retrieve. The default value is 1,000.

" + "smithy.api#documentation": "

An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.

" } }, "OutputDirectoryPath": { @@ -8152,7 +8224,7 @@ } ], "traits": { - "smithy.api#documentation": "

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

\n
    \n
  • \n

    For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.

    \n
    • \n
  • \n

    For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:

    \n
      \n
    • \n

      If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetrieveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.

      \n
      • \n
    • \n

      If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.

      \n
      • \n
    \n
    • \n
" + "smithy.api#documentation": "

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

  • For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.

  • For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:

    • If you are transferring file from a partner's SFTP server to Amazon Web Services storage, you specify one or more RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.

    • If you are transferring file to a partner's SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

" } }, "com.amazonaws.transfer#StartFileTransferRequest": { @@ -8168,7 +8240,7 @@ "SendFilePaths": { "target": "com.amazonaws.transfer#FilePaths", "traits": { - "smithy.api#documentation": "

One or more source paths for the Amazon S3 storage. Each string represents a source\n file path for one outbound file transfer. For example,\n \n amzn-s3-demo-bucket/myfile.txt\n .

\n \n

Replace \n amzn-s3-demo-bucket\n with one of your actual buckets.

\n " + "smithy.api#documentation": "

One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

Replace amzn-s3-demo-bucket with one of your actual buckets.

" } }, "RetrieveFilePaths": { @@ -8180,13 +8252,13 @@ "LocalDirectoryPath": { "target": "com.amazonaws.transfer#FilePath", "traits": { - "smithy.api#documentation": "

For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files\n that are transferred from the partner's SFTP server.

" + "smithy.api#documentation": "

For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.

" } }, "RemoteDirectoryPath": { "target": "com.amazonaws.transfer#FilePath", "traits": { - "smithy.api#documentation": "

For an outbound transfer, the RemoteDirectoryPath specifies the destination\n for one or more files that are transferred to the partner's SFTP server. If you don't specify\n a RemoteDirectoryPath, the destination for transferred files is the SFTP user's\n home directory.

" + "smithy.api#documentation": "

For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.

" } } }, @@ -8209,6 +8281,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.transfer#StartRemoteDelete": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#StartRemoteDeleteRequest" + }, + "output": { + "target": "com.amazonaws.transfer#StartRemoteDeleteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a file or directory on the remote SFTP server.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startRemoteDelete" + } + } + }, + "com.amazonaws.transfer#StartRemoteDeleteRequest": { + "type": "structure", + "members": { + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the connector.

", + "smithy.api#required": {} + } + }, + "DeletePath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "

The absolute path of the file or directory to delete. You can only specify one path per call to this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transfer#StartRemoteDeleteResponse": { + "type": "structure", + "members": { + "DeleteId": { + "target": "com.amazonaws.transfer#DeleteId", + "traits": { + "smithy.api#documentation": "

Returns a unique identifier for the delete operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.transfer#StartRemoteMove": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#StartRemoteMoveRequest" + }, + "output": { + "target": "com.amazonaws.transfer#StartRemoteMoveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.transfer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Moves or renames a file or directory on the remote SFTP server.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startRemoteMove" + } + } + }, + "com.amazonaws.transfer#StartRemoteMoveRequest": { + "type": "structure", + "members": { + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the connector.

", + "smithy.api#required": {} + } + }, + "SourcePath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "

The absolute path of the file or directory to move or rename. You can only specify one path per call to this operation.

", + "smithy.api#required": {} + } + }, + "TargetPath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "

The absolute path for the target of the move/rename operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transfer#StartRemoteMoveResponse": { + "type": "structure", + "members": { + "MoveId": { + "target": "com.amazonaws.transfer#MoveId", + "traits": { + "smithy.api#documentation": "

Returns a unique identifier for the move/rename operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transfer#StartServer": { "type": "operation", "input": { @@ -8235,7 +8454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the state of a file transfer protocol-enabled server from OFFLINE to\n ONLINE. It has no impact on a server that is already ONLINE. An\n ONLINE server can accept and process file transfer jobs.

\n

The state of STARTING indicates that the server is in an intermediate state,\n either not fully able to respond, or not fully online. The values of START_FAILED\n can indicate an error condition.

\n

No response is returned from this call.

" + "smithy.api#documentation": "

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

" } }, "com.amazonaws.transfer#StartServerRequest": { @@ -8294,7 +8513,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the condition of a file transfer protocol-enabled server with respect to its\n ability to perform file operations. There are six possible states: OFFLINE,\n ONLINE, STARTING, STOPPING,\n START_FAILED, and STOP_FAILED.

\n

\n OFFLINE indicates that the server exists, but that it is not available for\n file operations. ONLINE indicates that the server is available to perform file\n operations. STARTING indicates that the server's was instantiated, but the\n server is not yet available to perform file operations. Under normal conditions, it can take a\n couple of minutes for the server to be completely operational. Both START_FAILED\n and STOP_FAILED are error conditions.

" + "smithy.api#documentation": "

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

" } }, "com.amazonaws.transfer#Status": { @@ -8341,7 +8560,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.

\n \n

Stopping the server does not reduce or impact your file transfer protocol endpoint\n billing; you must delete the server to stop being billed.

\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

No response is returned from this call.

" + "smithy.api#documentation": "

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

" } }, "com.amazonaws.transfer#StopServerRequest": { @@ -8399,7 +8618,7 @@ } }, "traits": { - "smithy.api#documentation": "

Creates a key-value pair for a specific resource. Tags are metadata that you can use to\n search for and group a resource for various purposes. You can apply tags to servers, users,\n and roles. A tag key can take more than one value. For example, to group servers for\n accounting purposes, you might create a tag called Group and assign the values\n Research and Accounting to that group.

" + "smithy.api#documentation": "

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

" } }, "com.amazonaws.transfer#TagKey": { @@ -8446,7 +8665,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).\n Resources are users, servers, roles, and other entities.

\n

There is no response returned from this call.

" + "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

" } }, "com.amazonaws.transfer#TagResourceRequest": { @@ -8455,14 +8674,14 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or\n role.

", + "smithy.api#documentation": "

An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transfer#Tags", "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 resources (servers, users, workflows, and so on) for any purpose.

", + "smithy.api#documentation": "

Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.

", "smithy.api#required": {} } } @@ -8489,12 +8708,12 @@ "SourceFileLocation": { "target": "com.amazonaws.transfer#SourceFileLocation", "traits": { - "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.

\n
    \n
  • \n

    To use the previous file as the input, enter ${previous.file}.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.

    \n
    • \n
  • \n

    To use the originally uploaded file location as input for this step, enter ${original.file}.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

  • To use the originally uploaded file location as input for this step, enter ${original.file}.

" } } }, "traits": { - "smithy.api#documentation": "

Each step type has its own StepDetails structure.

\n

The key/value pairs used to tag a file during the execution of a workflow step.

" + "smithy.api#documentation": "

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

" } }, "com.amazonaws.transfer#TagValue": { @@ -8541,7 +8760,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this\n operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's\n SFTP server.

" + "smithy.api#documentation": "

Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.

" } }, "com.amazonaws.transfer#TestConnectionRequest": { @@ -8577,7 +8796,13 @@ "StatusMessage": { "target": "com.amazonaws.transfer#Message", "traits": { - "smithy.api#documentation": "

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message \n if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.

\n
    \n
  • \n

    Verify that your secret name aligns with the one in\n Transfer Role permissions.

    \n
    • \n
  • \n

    Verify the server URL in the connector\n configuration , and verify that the login credentials work successfully outside of the connector.

    \n
    • \n
  • \n

    Verify that the secret exists and is formatted correctly.

    \n
    • \n
  • \n

    Verify that the trusted host key in the connector\n configuration matches the ssh-keyscan output.

    \n
    • \n
" + "smithy.api#documentation": "

Returns Connection succeeded if the test is successful. Or, returns a descriptive error message if the test fails. The following list provides troubleshooting details, depending on the error message that you receive.

  • Verify that your secret name aligns with the one in Transfer Role permissions.

  • Verify the server URL in the connector configuration , and verify that the login credentials work successfully outside of the connector.

  • Verify that the secret exists and is formatted correctly.

  • Verify that the trusted host key in the connector configuration matches the ssh-keyscan output.

" + } + }, + "SftpConnectionDetails": { + "target": "com.amazonaws.transfer#SftpConnectorConnectionDetails", + "traits": { + "smithy.api#documentation": "

Structure that contains the SFTP connector host key.

" } } }, @@ -8608,7 +8833,7 @@ } ], "traits": { - "smithy.api#documentation": "

If the IdentityProviderType of a file transfer protocol-enabled server is\n AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity\n provider is set up successfully. We highly recommend that you call this operation to test your\n authentication method as soon as you create your server. By doing so, you can troubleshoot\n issues with the identity provider integration to ensure that your users can successfully use\n the service.

\n

\n The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. \n

\n

Note the following:

\n
    \n
  • \n

    You cannot use TestIdentityProvider if the\n IdentityProviderType of your server is SERVICE_MANAGED.

    \n
    • \n
  • \n

    \n TestIdentityProvider does not work with keys: it only accepts\n passwords.

    \n
    • \n
  • \n

    \n TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

    \n
    • \n
  • \n

    \n If you provide any incorrect values for any parameters, the Response field is empty.\n

    \n
    • \n
  • \n

    \n If you provide a server ID for a server that uses service-managed users, you get an error:\n

    \n

    \n \n An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth\n \n

    \n
    • \n
  • \n

    \n If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:\n

    \n

    \n An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.\n

    \n

    It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code,\n such as --region us-east-2 to specify a server in US East (Ohio).

    \n
    • \n
" + "smithy.api#documentation": "

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note the following:

  • You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

  • TestIdentityProvider does not work with keys: it only accepts passwords.

  • TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

  • If you provide any incorrect values for any parameters, the Response field is empty.

  • If you provide a server ID for a server that uses service-managed users, you get an error:

    An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

  • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

    An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.

    It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

" } }, "com.amazonaws.transfer#TestIdentityProviderRequest": { @@ -8617,14 +8842,14 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "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#documentation": "

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

", "smithy.api#required": {} } }, "ServerProtocol": { "target": "com.amazonaws.transfer#Protocol", "traits": { - "smithy.api#documentation": "

The type of file transfer protocol to be tested.

\n

The available protocols are:

\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
  • \n

    Applicability Statement 2 (AS2)

    \n
    • \n
" + "smithy.api#documentation": "

The type of file transfer protocol to be tested.

The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP)

  • File Transfer Protocol Secure (FTPS)

  • File Transfer Protocol (FTP)

  • Applicability Statement 2 (AS2)

" } }, "SourceIp": { @@ -8671,7 +8896,7 @@ "Message": { "target": "com.amazonaws.transfer#Message", "traits": { - "smithy.api#documentation": "

A message that indicates whether the test was successful or not.

\n \n

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

\n " + "smithy.api#documentation": "

A message that indicates whether the test was successful or not.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

" } }, "Url": { @@ -8796,6 +9021,12 @@ { "target": "com.amazonaws.transfer#StartFileTransfer" }, + { + "target": "com.amazonaws.transfer#StartRemoteDelete" + }, + { + "target": "com.amazonaws.transfer#StartRemoteMove" + }, { "target": "com.amazonaws.transfer#StartServer" }, @@ -8863,7 +9094,7 @@ "name": "transfer" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Transfer Family is a fully managed service that enables the transfer of files over the File\n Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File\n Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.\n Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.\n Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating\n with existing authentication systems, and providing DNS routing with Amazon Route 53 so\n nothing changes for your customers and partners, or their applications. With your data in\n Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and\n archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and\n set up.

", + "smithy.api#documentation": "

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

", "smithy.api#title": "AWS Transfer Family", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -9898,7 +10129,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name\n (ARN). Resources are users, servers, roles, and other entities.

\n

No response is returned from this call.

" + "smithy.api#documentation": "

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

" } }, "com.amazonaws.transfer#UntagResourceRequest": { @@ -9907,14 +10138,14 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is\n an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", + "smithy.api#documentation": "

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.transfer#TagKeys", "traits": { - "smithy.api#documentation": "

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for\n resources by type. This metadata can be attached to resources for any purpose.

", + "smithy.api#documentation": "

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

", "smithy.api#required": {} } } @@ -9952,7 +10183,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows you to update parameters for the access specified in the ServerID and\n ExternalID parameters.

" + "smithy.api#documentation": "

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

" } }, "com.amazonaws.transfer#UpdateAccessRequest": { @@ -9961,25 +10192,25 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

\n

For session policies, 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

For an example of a session policy, see Example\n session policy.

\n

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API\n Reference.

\n " + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

" } }, "PosixProfile": { @@ -9988,7 +10219,7 @@ "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

" } }, "ServerId": { @@ -10001,7 +10232,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n

In that command, replace YourGroupName with the name of your Active Directory group.

\n

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -10023,7 +10254,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

The external identifier of the group whose users have access to your Amazon S3 or Amazon\n EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

", + "smithy.api#documentation": "

The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

", "smithy.api#required": {} } } @@ -10068,7 +10299,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Updates some of the parameters for an existing agreement. Provide the\n AgreementId and the ServerId for the agreement that you want to\n update, along with the new values for the parameters to update.

\n \n

Specify either\n BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

\n

If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.

\n " + "smithy.api#documentation": "

Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.

Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail.

If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.

" } }, "com.amazonaws.transfer#UpdateAgreementRequest": { @@ -10097,49 +10328,49 @@ "Status": { "target": "com.amazonaws.transfer#AgreementStatusType", "traits": { - "smithy.api#documentation": "

You can update the status for the agreement, either activating an inactive agreement or\n the reverse.

" + "smithy.api#documentation": "

You can update the status for the agreement, either activating an inactive agreement or the reverse.

" } }, "LocalProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

\n

To change the local profile identifier, provide a new value\n here.

" + "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

" } }, "PartnerProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the partner profile.\n To change the partner profile identifier, provide a new value here.

" + "smithy.api#documentation": "

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

" } }, "BaseDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

To change the landing directory (folder) for files that are transferred, provide the\n bucket folder that you want to use; for example,\n /amzn-s3-demo-bucket/home/mydirectory\n .

" + "smithy.api#documentation": "

To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /amzn-s3-demo-bucket/home/mydirectory .

" } }, "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

" + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

" } }, "PreserveFilename": { "target": "com.amazonaws.transfer#PreserveFilenameType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload\n filename when saving it.\n

\n
    \n
  • \n

    \n ENABLED: the filename provided by your trading parter is preserved when the file is saved.

    \n
    • \n
  • \n

    \n DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as\n described in File names and locations.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

  • ENABLED: the filename provided by your trading parter is preserved when the file is saved.

  • DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

" } }, "EnforceMessageSigning": { "target": "com.amazonaws.transfer#EnforceMessageSigningType", "traits": { - "smithy.api#documentation": "

\n Determines whether or not unsigned messages from your trading partners will be accepted.\n

\n
    \n
  • \n

    \n ENABLED: Transfer Family rejects unsigned messages from your trading partner.

    \n
    • \n
  • \n

    \n DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

    \n
    • \n
" + "smithy.api#documentation": "

Determines whether or not unsigned messages from your trading partners will be accepted.

  • ENABLED: Transfer Family rejects unsigned messages from your trading partner.

  • DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

" } }, "CustomDirectories": { "target": "com.amazonaws.transfer#CustomDirectoriesType", "traits": { - "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

\n
    \n
  • \n

    Failed files

    \n
    • \n
  • \n

    MDN files

    \n
    • \n
  • \n

    Payload files

    \n
    • \n
  • \n

    Status files

    \n
    • \n
  • \n

    Temporary files

    \n
    • \n
" + "smithy.api#documentation": "

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

  • Failed files

  • MDN files

  • Payload files

  • Status files

  • Temporary files

" } } }, @@ -10210,13 +10441,13 @@ "ActiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

" } }, "InactiveDate": { "target": "com.amazonaws.transfer#CertDate", "traits": { - "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive.

" + "smithy.api#documentation": "

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

" } }, "Description": { @@ -10281,7 +10512,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Updates some of the parameters for an existing connector. Provide the\n ConnectorId for the connector that you want to update, along with the new\n values for the parameters to update.

" + "smithy.api#documentation": "

Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.

" } }, "com.amazonaws.transfer#UpdateConnectorRequest": { @@ -10309,13 +10540,13 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

\n

\n For AS2 connectors\n

\n

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file\u2019s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.

\n

If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.

\n

\n For SFTP connectors\n

\n

Make sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.

" + "smithy.api#documentation": "

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file\u2019s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn\n on CloudWatch logging for Amazon S3 events. When set, you can view connector\n activity in your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

" } }, "SftpConfig": { @@ -10376,7 +10607,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description for the host key that's specified by the ServerId and\n HostKeyId parameters.

" + "smithy.api#documentation": "

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

" } }, "com.amazonaws.transfer#UpdateHostKeyRequest": { @@ -10462,7 +10693,7 @@ "transfer:UnTagResource" ] }, - "smithy.api#documentation": "

Updates some of the parameters for an existing profile. Provide the ProfileId\n for the profile that you want to update, along with the new values for the parameters to\n update.

" + "smithy.api#documentation": "

Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

" } }, "com.amazonaws.transfer#UpdateProfileRequest": { @@ -10564,7 +10795,7 @@ "logs:DescribeLogGroups" ] }, - "smithy.api#documentation": "

Updates the file transfer protocol-enabled server's properties after that server has\n been created.

\n

The UpdateServer call returns the ServerId of the server you\n updated.

" + "smithy.api#documentation": "

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

" } }, "com.amazonaws.transfer#UpdateServerRequest": { @@ -10573,62 +10804,62 @@ "Certificate": { "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n

To request a new public certificate, see Request a public certificate\n in the Amazon Web ServicesCertificate Manager User Guide.

\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the Amazon Web ServicesCertificate Manager User Guide.

\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Amazon Web ServicesCertificate Manager User\n Guide.

\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\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

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": "

The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

" } }, "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { - "smithy.api#documentation": "

The protocol settings that are configured for your server.

\n
    \n
  • \n

    \n To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n

    \n
    • \n
  • \n

    To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are \n uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the \n SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to \n ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family \n generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT \n call.

    \n
    • \n
  • \n

    To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the \n TlsSessionResumptionMode parameter.

    \n
    • \n
  • \n

    \n As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    \n
    • \n
" + "smithy.api#documentation": "

The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

" } }, "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "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 your endpoint accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

" + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\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 type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

" } }, "HostKey": { "target": "com.amazonaws.transfer#HostKey", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want\n to rotate keys, or have a set of active keys that use different algorithms.

\n

Use the following command to generate an RSA 2048 bit key with no passphrase:

\n

\n ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

\n

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

\n

Use the following command to generate an ECDSA 256 bit key with no passphrase:

\n

\n ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

\n

Valid values for the -b option for ECDSA are 256, 384, and 521.

\n

Use the following command to generate an ED25519 key with no passphrase:

\n

\n ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

\n

For all of these commands, you can replace my-new-server-key with a string of your choice.

\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

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" + "smithy.api#documentation": "

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N \"\" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

" } }, "IdentityProviderDetails": { "target": "com.amazonaws.transfer#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

An array containing all of the information required to call a customer's\n authentication API method.

" + "smithy.api#documentation": "

An array containing all of the information required to call a customer's authentication API method.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#NullableRole", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

" } }, "PostAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PostAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

\n \n

The SFTP protocol does not support post-authentication display banners.

\n " + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

" } }, "PreAuthenticationLoginBanner": { "target": "com.amazonaws.transfer#PreAuthenticationLoginBanner", "traits": { - "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates.\n For example, the following banner displays details about using the system:

\n

\n This system is for the use of authorized users only. Individuals using this computer system without authority,\n or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by\n system personnel.\n

" + "smithy.api#documentation": "

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

" } }, "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 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 AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    \n
    • \n
\n \n
    \n
  • \n

    If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) \n which is used to identify your server when clients connect to it over\n FTPS.

    \n
    • \n
  • \n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n
    • \n
  • \n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: \n SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

    \n
    • \n
  • \n

    If Protocol includes AS2, then the\n EndpointType must be VPC, and domain must be Amazon S3.

    \n
    • \n
\n " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

" } }, "SecurityPolicyName": { @@ -10640,26 +10871,26 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a server instance that the Transfer Family user is\n assigned to.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.

", "smithy.api#required": {} } }, "WorkflowDetails": { "target": "com.amazonaws.transfer#WorkflowDetails", "traits": { - "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

\n

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a\n workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n while the file is still being uploaded.

\n

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

\n

\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n

" + "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'

" } }, "StructuredLogDestinations": { "target": "com.amazonaws.transfer#StructuredLogDestinations", "traits": { - "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

\n

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

\n

\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n

\n

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n

\n

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n value for this parameter in an update-server call. For example:

\n

\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n

" + "smithy.api#documentation": "

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

" } }, "S3StorageOptions": { "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

\n

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } } }, @@ -10673,7 +10904,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a server that the Transfer Family user is assigned\n to.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a server that the Transfer Family user is assigned to.

", "smithy.api#required": {} } } @@ -10718,7 +10949,7 @@ "transfer:UnTagResource" ] }, - "smithy.api#documentation": "

Assigns new properties to a user. Parameters you pass modify any or all of the following:\n the home directory, role, and policy for the UserName and ServerId\n you specify.

\n

The response returns the ServerId and the UserName for the\n updated user.

\n

In the console, you can select Restricted when you create or update a\n user. This ensures that the user can't access anything outside of their home directory. The\n programmatic way to configure this behavior is to update the user. Set their\n HomeDirectoryType to LOGICAL, and specify\n HomeDirectoryMappings with Entry as root (/) and\n Target as their home directory.

\n

For example, if the user's home directory is /test/admin-user, the following\n command updates the user so that their configuration in the console shows the\n Restricted flag as selected.

\n

\n aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings \"[{\\\"Entry\\\":\\\"/\\\", \\\"Target\\\":\\\"/test/admin-user\\\"}]\"\n

" + "smithy.api#documentation": "

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify HomeDirectoryMappings with Entry as root (/) and Target as their home directory.

For example, if the user's home directory is /test/admin-user, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.

aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings \"[{\\\"Entry\\\":\\\"/\\\", \\\"Target\\\":\\\"/test/admin-user\\\"}]\"

" } }, "com.amazonaws.transfer#UpdateUserRequest": { @@ -10727,50 +10958,50 @@ "HomeDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

\n

A HomeDirectory example is /bucket_name/home/mydirectory.

\n \n

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

\n " + "smithy.api#documentation": "

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

" } }, "HomeDirectoryType": { "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.\n If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer \n protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for \n how you want to make Amazon S3 or Amazon EFS paths visible to your users.

\n \n

If HomeDirectoryType is LOGICAL, you must provide mappings,\n using the HomeDirectoryMappings parameter. If, on the other hand,\n HomeDirectoryType is PATH, you provide an absolute path\n using the HomeDirectory parameter. You cannot have both\n HomeDirectory and HomeDirectoryMappings in your\n template.

\n " + "smithy.api#documentation": "

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

" } }, "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) \n role provides access to paths in Target. This value\n can be set only when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]

" } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

\n

For session policies, 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

For an example of a session policy, see Creating a session\n policy.

\n

For more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.

\n " + "smithy.api#documentation": "

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Creating a session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

" } }, "PosixProfile": { "target": "com.amazonaws.transfer#PosixProfile", "traits": { - "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID\n (Gid), and any secondary groups IDs (SecondaryGids), that controls\n your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions\n that are set on files and directories in your file system determines the level of access your\n users get when transferring files into and out of your Amazon EFS file systems.

" + "smithy.api#documentation": "

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

" } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 \n bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users \n when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust \n relationship that allows the server to access your resources when servicing your users' transfer requests.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

" } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a Transfer Family server instance that the user is\n assigned to.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a Transfer Family server instance that the user is 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 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#documentation": "

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

", "smithy.api#required": {} } } @@ -10785,20 +11016,20 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

A system-assigned unique identifier for a Transfer Family server instance that the account is\n assigned to.

", + "smithy.api#documentation": "

A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.

", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "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#documentation": "

The unique identifier for a user that is assigned to a server instance that was specified in the request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n UpdateUserResponse returns the user name and identifier for the request to\n update a user's properties.

", + "smithy.api#documentation": "

UpdateUserResponse returns the user name and identifier for the request to update a user's properties.

", "smithy.api#output": {} } }, @@ -10912,7 +11143,7 @@ "FaviconFile": { "target": "com.amazonaws.transfer#WebAppFaviconFile", "traits": { - "smithy.api#documentation": "

Specify icon file data string (in base64 encoding).

" + "smithy.api#documentation": "

Specify an icon file data string (in base64 encoding).

" } } }, @@ -11180,6 +11411,23 @@ } } }, + "com.amazonaws.transfer#WebAppEndpointPolicy": { + "type": "enum", + "members": { + "FIPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIPS" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, "com.amazonaws.transfer#WebAppFaviconFile": { "type": "blob", "traits": { @@ -11284,7 +11532,7 @@ "Provisioned": { "target": "com.amazonaws.transfer#WebAppUnitCount", "traits": { - "smithy.api#documentation": "

An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.

\n

Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.

" + "smithy.api#documentation": "

An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.

Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.

" } } }, @@ -11315,13 +11563,13 @@ "ExecutionRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can\n assume, so that all workflow steps can operate on the required resources

", + "smithy.api#documentation": "

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

\n

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a\n workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n while the file is still being uploaded.

" + "smithy.api#documentation": "

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

" } }, "com.amazonaws.transfer#WorkflowDetails": { @@ -11330,18 +11578,18 @@ "OnUpload": { "target": "com.amazonaws.transfer#OnUploadWorkflowDetails", "traits": { - "smithy.api#documentation": "

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

\n

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

\n

\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n

\n \n

\n OnUpload can contain a maximum of one WorkflowDetail object.

\n " + "smithy.api#documentation": "

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'

OnUpload can contain a maximum of one WorkflowDetail object.

" } }, "OnPartialUpload": { "target": "com.amazonaws.transfer#OnPartialUploadWorkflowDetails", "traits": { - "smithy.api#documentation": "

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server\n that executes whenever there is a partial upload.

\n

A partial upload occurs when a file is open when the session disconnects.

\n \n

\n OnPartialUpload can contain a maximum of one WorkflowDetail object.

\n " + "smithy.api#documentation": "

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

" } } }, "traits": { - "smithy.api#documentation": "

Container for the WorkflowDetail data type.\n It is used by actions that trigger a workflow to begin execution.

" + "smithy.api#documentation": "

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

" } }, "com.amazonaws.transfer#WorkflowId": { @@ -11394,19 +11642,19 @@ "Type": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

\n Currently, the following step types are supported.\n

\n
    \n
  • \n

    \n \n COPY\n - Copy the file to another location.

    \n
    • \n
  • \n

    \n \n CUSTOM\n - Perform a custom step with an Lambda function target.

    \n
    • \n
  • \n

    \n \n DECRYPT\n - Decrypt a file that was encrypted before it was uploaded.

    \n
    • \n
  • \n

    \n \n DELETE\n - Delete the file.

    \n
    • \n
  • \n

    \n \n TAG\n - Add a tag to the file.

    \n
    • \n
" + "smithy.api#documentation": "

Currently, the following step types are supported.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Lambda function target.

  • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

  • DELETE - Delete the file.

  • TAG - Add a tag to the file.

" } }, "CopyStepDetails": { "target": "com.amazonaws.transfer#CopyStepDetails", "traits": { - "smithy.api#documentation": "

Details for a step that performs a file copy.

\n

\n Consists of the following values:\n

\n
    \n
  • \n

    A description

    \n
    • \n
  • \n

    An Amazon S3 location for the destination of the file copy.

    \n
    • \n
  • \n

    A flag that indicates whether to overwrite an existing file of the same name. The default is\n FALSE.

    \n
    • \n
" + "smithy.api#documentation": "

Details for a step that performs a file copy.

Consists of the following values:

  • A description

  • An Amazon S3 location for the destination of the file copy.

  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

" } }, "CustomStepDetails": { "target": "com.amazonaws.transfer#CustomStepDetails", "traits": { - "smithy.api#documentation": "

Details for a step that invokes an Lambda function.

\n

Consists of the Lambda function's name, target, and timeout (in seconds).

" + "smithy.api#documentation": "

Details for a step that invokes an Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

" } }, "DeleteStepDetails": { @@ -11418,13 +11666,13 @@ "TagStepDetails": { "target": "com.amazonaws.transfer#TagStepDetails", "traits": { - "smithy.api#documentation": "

Details for a step that creates one or more tags.

\n

You specify one or more tags. Each tag contains a key-value pair.

" + "smithy.api#documentation": "

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

" } }, "DecryptStepDetails": { "target": "com.amazonaws.transfer#DecryptStepDetails", "traits": { - "smithy.api#documentation": "

Details for a step that decrypts an encrypted file.

\n

Consists of the following values:

\n
    \n
  • \n

    A descriptive name

    \n
    • \n
  • \n

    An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to\n decrypt.

    \n
    • \n
  • \n

    An S3 or Amazon EFS location for the destination of the file decryption.

    \n
    • \n
  • \n

    A flag that indicates whether to overwrite an existing file of the same name. The default is\n FALSE.

    \n
    • \n
  • \n

    The type of encryption that's used. Currently, only PGP encryption is supported.

    \n
    • \n
" + "smithy.api#documentation": "

Details for a step that decrypts an encrypted file.

Consists of the following values:

  • A descriptive name

  • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

  • An S3 or Amazon EFS location for the destination of the file decryption.

  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

  • The type of encryption that's used. Currently, only PGP encryption is supported.

" } } }, diff --git a/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json b/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json index dbd66d21..78a719d6 100644 --- a/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json +++ b/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json @@ -1722,6 +1722,12 @@ "traits": { "smithy.api#documentation": "

Descriptive text that you can provide to help with identification \n of the current policy store.

" } + }, + "deletionProtection": { + "target": "com.amazonaws.verifiedpermissions#DeletionProtection", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

\n

The default state is DISABLED.

" + } } }, "traits": { @@ -2044,6 +2050,11 @@ "output": { "target": "com.amazonaws.verifiedpermissions#DeletePolicyStoreOutput" }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#InvalidStateException" + } + ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the specified policy store" @@ -2148,6 +2159,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.verifiedpermissions#DeletionProtection": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.verifiedpermissions#DeterminingPolicyItem": { "type": "structure", "members": { @@ -2722,6 +2750,12 @@ "traits": { "smithy.api#documentation": "

Descriptive text that you can provide to help with identification \n of the current policy store.

" } + }, + "deletionProtection": { + "target": "com.amazonaws.verifiedpermissions#DeletionProtection", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

\n

The default state is DISABLED.

" + } } }, "traits": { @@ -3196,6 +3230,22 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.verifiedpermissions#InvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy store can't be deleted because deletion protection is enabled. To delete this policy store, disable deletion protection.

", + "smithy.api#error": "client", + "smithy.api#httpError": 406 + } + }, "com.amazonaws.verifiedpermissions#IpAddr": { "type": "string", "traits": { @@ -5959,6 +6009,12 @@ "smithy.api#required": {} } }, + "deletionProtection": { + "target": "com.amazonaws.verifiedpermissions#DeletionProtection", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

\n

When you call UpdatePolicyStore, this parameter is unchanged unless explicitly included in the call.

" + } + }, "description": { "target": "com.amazonaws.verifiedpermissions#PolicyStoreDescription", "traits": {