From 009e672de4cb466519b787a31963f1fe0e473002 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 24 Aug 2022 18:12:37 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/cloudfront.json | 812 +++++++++++++++++- .../aws-models/config-service.json | 59 +- codegen/sdk-codegen/aws-models/iam.json | 8 +- codegen/sdk-codegen/aws-models/ivs.json | 8 +- .../sdk-codegen/aws-models/quicksight.json | 77 +- codegen/sdk-codegen/aws-models/transfer.json | 44 +- 6 files changed, 956 insertions(+), 52 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/cloudfront.json b/codegen/sdk-codegen/aws-models/cloudfront.json index 3b9b57fcf52..4988c15a1ff 100644 --- a/codegen/sdk-codegen/aws-models/cloudfront.json +++ b/codegen/sdk-codegen/aws-models/cloudfront.json @@ -1034,6 +1034,9 @@ { "target": "com.amazonaws.cloudfront#CreateMonitoringSubscription" }, + { + "target": "com.amazonaws.cloudfront#CreateOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#CreateOriginRequestPolicy" }, @@ -1076,6 +1079,9 @@ { "target": "com.amazonaws.cloudfront#DeleteMonitoringSubscription" }, + { + "target": "com.amazonaws.cloudfront#DeleteOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicy" }, @@ -1139,6 +1145,12 @@ { "target": "com.amazonaws.cloudfront#GetMonitoringSubscription" }, + { + "target": "com.amazonaws.cloudfront#GetOriginAccessControl" + }, + { + "target": "com.amazonaws.cloudfront#GetOriginAccessControlConfig" + }, { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicy" }, @@ -1211,6 +1223,9 @@ { "target": "com.amazonaws.cloudfront#ListKeyGroups" }, + { + "target": "com.amazonaws.cloudfront#ListOriginAccessControls" + }, { "target": "com.amazonaws.cloudfront#ListOriginRequestPolicies" }, @@ -1262,6 +1277,9 @@ { "target": "com.amazonaws.cloudfront#UpdateKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#UpdateOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#UpdateOriginRequestPolicy" }, @@ -1666,6 +1684,9 @@ { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, + { + "target": "com.amazonaws.cloudfront#IllegalOriginAccessConfiguration" + }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, @@ -1675,6 +1696,9 @@ { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, + { + "target": "com.amazonaws.cloudfront#InvalidDomainNameForOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, @@ -1702,6 +1726,9 @@ { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, @@ -1783,6 +1810,9 @@ { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, @@ -1917,6 +1947,9 @@ { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, + { + "target": "com.amazonaws.cloudfront#InvalidDomainNameForOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, @@ -1944,6 +1977,9 @@ { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, @@ -2554,6 +2590,9 @@ { "target": "com.amazonaws.cloudfront#AccessDenied" }, + { + "target": "com.amazonaws.cloudfront#MonitoringSubscriptionAlreadyExists" + }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, @@ -2604,6 +2643,74 @@ } } }, + "com.amazonaws.cloudfront#CreateOriginAccessControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateOriginAccessControlRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateOriginAccessControlResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#OriginAccessControlAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOriginAccessControls" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new origin access control in CloudFront. After you create an origin access control, you\n\t\t\tcan add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed)\n\t\t\trequests to the origin.

\n\t\t

For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket\n\t\t\tso that viewers (users) can access the content in the bucket only through CloudFront.

\n\t\t

For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/origin-access-control", + "code": 201 + } + } + }, + "com.amazonaws.cloudfront#CreateOriginAccessControlRequest": { + "type": "structure", + "members": { + "OriginAccessControlConfig": { + "target": "com.amazonaws.cloudfront#OriginAccessControlConfig", + "traits": { + "smithy.api#documentation": "

Contains the origin access control.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "OriginAccessControlConfig" + } + } + } + }, + "com.amazonaws.cloudfront#CreateOriginAccessControlResult": { + "type": "structure", + "members": { + "OriginAccessControl": { + "target": "com.amazonaws.cloudfront#OriginAccessControl", + "traits": { + "smithy.api#documentation": "

Contains an origin access control.

", + "smithy.api#httpPayload": {} + } + }, + "Location": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The URL of the origin access control.

", + "smithy.api#httpHeader": "Location" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The version identifier for the current version of the origin access control.

", + "smithy.api#httpHeader": "ETag" + } + } + } + }, "com.amazonaws.cloudfront#CreateOriginRequestPolicy": { "type": "operation", "input": { @@ -2934,6 +3041,9 @@ { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, @@ -3035,6 +3145,9 @@ { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, @@ -3765,6 +3878,9 @@ { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, + { + "target": "com.amazonaws.cloudfront#NoSuchMonitoringSubscription" + }, { "target": "com.amazonaws.cloudfront#UnsupportedOperation" } @@ -3795,6 +3911,60 @@ "type": "structure", "members": {} }, + "com.amazonaws.cloudfront#DeleteOriginAccessControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#DeleteOriginAccessControlRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginAccessControl" + }, + { + "target": "com.amazonaws.cloudfront#OriginAccessControlInUse" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CloudFront origin access control.

\n\t\t

You cannot delete an origin access control if it's in use. First, update all distributions\n\t\t\tto remove the origin access control from all origins, then delete the origin access\n\t\t\tcontrol.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-05-31/origin-access-control/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.cloudfront#DeleteOriginAccessControlRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control that you are deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version (ETag value) of the origin access control that you are\n\t\t\tdeleting.

", + "smithy.api#httpHeader": "If-Match" + } + } + } + }, "com.amazonaws.cloudfront#DeleteOriginRequestPolicy": { "type": "operation", "input": { @@ -6435,6 +6605,9 @@ { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, + { + "target": "com.amazonaws.cloudfront#NoSuchMonitoringSubscription" + }, { "target": "com.amazonaws.cloudfront#UnsupportedOperation" } @@ -6473,6 +6646,120 @@ } } }, + "com.amazonaws.cloudfront#GetOriginAccessControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetOriginAccessControlRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetOriginAccessControlResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginAccessControl" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a CloudFront origin access control.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-control/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetOriginAccessControlConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetOriginAccessControlConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetOriginAccessControlConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginAccessControl" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a CloudFront origin access control.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-control/{Id}/config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetOriginAccessControlConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudfront#GetOriginAccessControlConfigResult": { + "type": "structure", + "members": { + "OriginAccessControlConfig": { + "target": "com.amazonaws.cloudfront#OriginAccessControlConfig", + "traits": { + "smithy.api#documentation": "

Contains an origin access control.

", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The version identifier for the current version of the origin access control.

", + "smithy.api#httpHeader": "ETag" + } + } + } + }, + "com.amazonaws.cloudfront#GetOriginAccessControlRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudfront#GetOriginAccessControlResult": { + "type": "structure", + "members": { + "OriginAccessControl": { + "target": "com.amazonaws.cloudfront#OriginAccessControl", + "traits": { + "smithy.api#documentation": "

Contains an origin access control.

", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The version identifier for the current version of the origin access control.

", + "smithy.api#httpHeader": "ETag" + } + } + } + }, "com.amazonaws.cloudfront#GetOriginRequestPolicy": { "type": "operation", "input": { @@ -7113,6 +7400,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#IllegalOriginAccessConfiguration": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

An origin cannot contain both an origin access control (OAC) and an origin access identity\n\t\t\t(OAI).

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#IllegalUpdate": { "type": "structure", "members": { @@ -7165,6 +7465,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#InvalidDomainNameForOriginAccessControl": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

An origin access control is associated with an origin whose domain name is not\n\t\t\tsupported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#InvalidErrorCode": { "type": "structure", "members": { @@ -7295,6 +7608,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#InvalidOriginAccessControl": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The origin access control is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#InvalidOriginAccessIdentity": { "type": "structure", "members": { @@ -8845,18 +9171,71 @@ } } }, - "com.amazonaws.cloudfront#ListOriginRequestPolicies": { + "com.amazonaws.cloudfront#ListOriginAccessControls": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesRequest" + "target": "com.amazonaws.cloudfront#ListOriginAccessControlsRequest" }, "output": { - "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesResult" + "target": "com.amazonaws.cloudfront#ListOriginAccessControlsResult" }, "errors": [ - { - "target": "com.amazonaws.cloudfront#AccessDenied" - }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If the\n\t\t\ttotal number of items in the list exceeds the maximum that you specify, or the default\n\t\t\tmaximum, the response is paginated. To get the next page of items, send another request\n\t\t\tthat specifies the NextMarker value from the current response as the\n\t\t\tMarker value in the next request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-control", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#ListOriginAccessControlsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of origin\n\t\t\taccess controls. The response includes the items in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\tNextMarker from the current page's response.

", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of origin access controls that you want in the response.

", + "smithy.api#httpQuery": "MaxItems" + } + } + } + }, + "com.amazonaws.cloudfront#ListOriginAccessControlsResult": { + "type": "structure", + "members": { + "OriginAccessControlList": { + "target": "com.amazonaws.cloudfront#OriginAccessControlList", + "traits": { + "smithy.api#documentation": "

A list of origin access controls.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.cloudfront#ListOriginRequestPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, @@ -9368,6 +9747,19 @@ "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

" } }, + "com.amazonaws.cloudfront#MonitoringSubscriptionAlreadyExists": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

A monitoring subscription already exists for the specified distribution.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudfront#NoSuchCachePolicy": { "type": "structure", "members": { @@ -9459,6 +9851,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudfront#NoSuchMonitoringSubscription": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

A monitoring subscription does not exist for the specified distribution.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.cloudfront#NoSuchOrigin": { "type": "structure", "members": { @@ -9472,6 +9877,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudfront#NoSuchOriginAccessControl": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The origin access control does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy": { "type": "structure", "members": { @@ -9608,12 +10026,256 @@ "traits": { "smithy.api#documentation": "

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your\n origin.

\n\t\t

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

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

The unique identifier of an origin access control for this origin.

\n\t\t

For more information, see Restricting access to an Amazon S3 origin in the\n\t\t\tAmazon CloudFront Developer Guide.

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

An origin.

\n\t\t

An origin is the location where content is stored, and from which CloudFront gets content to\n\t\t\tserve to viewers. To specify an origin:

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

For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide\n\t\t\t(quotas were formerly referred to as limits).

" } }, + "com.amazonaws.cloudfront#OriginAccessControl": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control.

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

The origin access control.

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

A CloudFront origin access control.

" + } + }, + "com.amazonaws.cloudfront#OriginAccessControlAlreadyExists": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

An origin access control with the specified parameters already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudfront#OriginAccessControlConfig": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A name to identify the origin access control.

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

A description of the origin access control.

", + "smithy.api#required": {} + } + }, + "SigningProtocol": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSigningProtocols", + "traits": { + "smithy.api#documentation": "

The signing protocol of the origin access control, which determines how CloudFront signs\n\t\t\t(authenticates) requests. The only valid value is sigv4.

", + "smithy.api#required": {} + } + }, + "SigningBehavior": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors", + "traits": { + "smithy.api#documentation": "

Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\talways for the most common use case. For more information, see origin access control advanced settings in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

This field can have one of the following values:

\n\t\t ", + "smithy.api#required": {} + } + }, + "OriginAccessControlOriginType": { + "target": "com.amazonaws.cloudfront#OriginAccessControlOriginTypes", + "traits": { + "smithy.api#documentation": "

The type of origin that this origin access control is for. The only valid value is\n\t\t\ts3.

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

A CloudFront origin access control.

" + } + }, + "com.amazonaws.cloudfront#OriginAccessControlInUse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

Cannot delete the origin access control because it's in use by one or more\n\t\t\tdistributions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudfront#OriginAccessControlList": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The value of the Marker field that was provided in the request.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value to use in the Marker field of another request to\n\t\t\tcontinue listing origin access controls.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The maximum number of origin access controls requested.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

If there are more items in the list than are in this response, this value is\n\t\t\ttrue.

", + "smithy.api#required": {} + } + }, + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The number of origin access controls returned in the response.

", + "smithy.api#required": {} + } + }, + "Items": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSummaryList", + "traits": { + "smithy.api#documentation": "

Contains the origin access controls in the list.

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

A list of CloudFront origin access controls.

" + } + }, + "com.amazonaws.cloudfront#OriginAccessControlOriginTypes": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "s3", + "name": "s3" + } + ] + } + }, + "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "never", + "name": "never" + }, + { + "value": "always", + "name": "always" + }, + { + "value": "no-override", + "name": "no_override" + } + ] + } + }, + "com.amazonaws.cloudfront#OriginAccessControlSigningProtocols": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "sigv4", + "name": "sigv4" + } + ] + } + }, + "com.amazonaws.cloudfront#OriginAccessControlSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control.

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

A description of the origin access control.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A unique name that identifies the origin access control.

", + "smithy.api#required": {} + } + }, + "SigningProtocol": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSigningProtocols", + "traits": { + "smithy.api#documentation": "

The signing protocol of the origin access control. The signing protocol determines how\n\t\t\tCloudFront signs (authenticates) requests. The only valid value is sigv4.

", + "smithy.api#required": {} + } + }, + "SigningBehavior": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors", + "traits": { + "smithy.api#documentation": "

A value that specifies which requests CloudFront signs (adds authentication information to).\n\t\t\tThis field can have one of the following values:

\n\t\t ", + "smithy.api#required": {} + } + }, + "OriginAccessControlOriginType": { + "target": "com.amazonaws.cloudfront#OriginAccessControlOriginTypes", + "traits": { + "smithy.api#documentation": "

The type of origin that this origin access control is for. The only valid value is\n\t\t\ts3.

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

A CloudFront origin access control.

" + } + }, + "com.amazonaws.cloudfront#OriginAccessControlSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#OriginAccessControlSummary", + "traits": { + "smithy.api#xmlName": "OriginAccessControlSummary" + } + } + }, "com.amazonaws.cloudfront#OriginCustomHeader": { "type": "structure", "members": { @@ -11092,17 +11754,17 @@ "smithy.api#documentation": "

A configuration for a set of security-related HTTP response headers.

" } }, - "CustomHeadersConfig": { - "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeadersConfig", - "traits": { - "smithy.api#documentation": "

A configuration for a set of custom HTTP response headers.

" - } - }, "ServerTimingHeadersConfig": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig", "traits": { "smithy.api#documentation": "

A configuration for enabling the Server-Timing header in HTTP responses\n\t\t\tsent from CloudFront.

" } + }, + "CustomHeadersConfig": { + "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeadersConfig", + "traits": { + "smithy.api#documentation": "

A configuration for a set of custom HTTP response headers.

" + } } }, "traits": { @@ -12502,6 +13164,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified origin\n\t\t\taccess control.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy": { "type": "structure", "members": { @@ -12762,6 +13437,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#TooManyOriginAccessControls": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The number of origin access controls in your Amazon Web Services account exceeds the maximum\n\t\t\tallowed.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#TooManyOriginCustomHeaders": { "type": "structure", "members": { @@ -13319,6 +14007,9 @@ { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, + { + "target": "com.amazonaws.cloudfront#IllegalOriginAccessConfiguration" + }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, @@ -13331,6 +14022,9 @@ { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, + { + "target": "com.amazonaws.cloudfront#InvalidDomainNameForOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, @@ -13358,6 +14052,9 @@ { "target": "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, @@ -13930,6 +14627,94 @@ } } }, + "com.amazonaws.cloudfront#UpdateOriginAccessControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateOriginAccessControlRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateOriginAccessControlResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#IllegalUpdate" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginAccessControl" + }, + { + "target": "com.amazonaws.cloudfront#OriginAccessControlAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a CloudFront origin access control.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/origin-access-control/{Id}/config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#UpdateOriginAccessControlRequest": { + "type": "structure", + "members": { + "OriginAccessControlConfig": { + "target": "com.amazonaws.cloudfront#OriginAccessControlConfig", + "traits": { + "smithy.api#documentation": "

An origin access control.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "OriginAccessControlConfig" + } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier of the origin access control that you are updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version (ETag value) of the origin access control that you are\n\t\t\tupdating.

", + "smithy.api#httpHeader": "If-Match" + } + } + } + }, + "com.amazonaws.cloudfront#UpdateOriginAccessControlResult": { + "type": "structure", + "members": { + "OriginAccessControl": { + "target": "com.amazonaws.cloudfront#OriginAccessControl", + "traits": { + "smithy.api#documentation": "

The origin access control after it has been updated.

", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The new version of the origin access control after it has been updated.

", + "smithy.api#httpHeader": "ETag" + } + } + } + }, "com.amazonaws.cloudfront#UpdateOriginRequestPolicy": { "type": "operation", "input": { @@ -14316,6 +15101,9 @@ { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, diff --git a/codegen/sdk-codegen/aws-models/config-service.json b/codegen/sdk-codegen/aws-models/config-service.json index 478d8ae5d76..b6404b95159 100644 --- a/codegen/sdk-codegen/aws-models/config-service.json +++ b/codegen/sdk-codegen/aws-models/config-service.json @@ -1999,13 +1999,19 @@ "LastUpdateRequestedTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

Last time when conformation pack update was requested.

" + "smithy.api#documentation": "

The last time a conformation pack update was requested.

" } }, "CreatedBy": { "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

Amazon Web Services service that created the conformance pack.

" + "smithy.api#documentation": "

The Amazon Web Services service that created the conformance pack.

" + } + }, + "TemplateSSMDocumentDetails": { + "target": "com.amazonaws.configservice#TemplateSSMDocumentDetails", + "traits": { + "smithy.api#documentation": "

An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

" } } }, @@ -6573,7 +6579,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates one of the following errors:

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

Indicates one of the following errors:

\n\t\t ", "smithy.api#error": "client" } }, @@ -8929,7 +8935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.\n\t\t\tFor information on how many conformance packs you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n\t\t

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service-linked role is created only when the role does not exist in your account.

\n\t\t \n

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. \n\t\t\tIf you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

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

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.\n\t\t\tFor information on how many conformance packs you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n\t\t

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service-linked role is created only when the role does not exist in your account.

\n\t\t \n

You must specify one and only one of theTemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails parameters.

\n
" } }, "com.amazonaws.configservice#PutConformancePackRequest": { @@ -8938,20 +8944,20 @@ "ConformancePackName": { "target": "com.amazonaws.configservice#ConformancePackName", "traits": { - "smithy.api#documentation": "

Name of the conformance pack you want to create.

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

The unique name of the conformance pack you want to deploy.

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

Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

\n\t\t \n

You must have access to read Amazon S3 bucket.

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

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

\n\t\t \n

You must have access to read Amazon S3 bucket.

\n
" } }, "TemplateBody": { "target": "com.amazonaws.configservice#TemplateBody", "traits": { - "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and a remediation action (AWS::Config::RemediationConfiguration).

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

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

\n
" } }, "DeliveryS3Bucket": { @@ -8971,6 +8977,12 @@ "traits": { "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" } + }, + "TemplateSSMDocumentDetails": { + "target": "com.amazonaws.configservice#TemplateSSMDocumentDetails", + "traits": { + "smithy.api#documentation": "

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

" + } } } }, @@ -11136,6 +11148,18 @@ } } }, + "com.amazonaws.configservice#SSMDocumentName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$" + } + }, + "com.amazonaws.configservice#SSMDocumentVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)$" + } + }, "com.amazonaws.configservice#SchemaVersionId": { "type": "string", "traits": { @@ -12285,6 +12309,27 @@ "smithy.api#pattern": "^s3://" } }, + "com.amazonaws.configservice#TemplateSSMDocumentDetails": { + "type": "structure", + "members": { + "DocumentName": { + "target": "com.amazonaws.configservice#SSMDocumentName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.\n\t\t\tIf you use the Document Name, Config checks only your account and region for the SSM document. If you want to use an SSM document from another region or account, you must provide the ARN.

", + "smithy.api#required": {} + } + }, + "DocumentVersion": { + "target": "com.amazonaws.configservice#SSMDocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

\n\t\t \n

This field is optional.

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

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). \n\t\t\tTo deploy a conformance pack using an SSM document, you first create an SSM document with conformance pack content, and then provide the DocumentName (and optionally DocumentVersion) in the PutConformancePack API.

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

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

" + } + }, "com.amazonaws.configservice#TooManyTagsException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/iam.json b/codegen/sdk-codegen/aws-models/iam.json index e523525ba6b..bf6b7e99264 100644 --- a/codegen/sdk-codegen/aws-models/iam.json +++ b/codegen/sdk-codegen/aws-models/iam.json @@ -5723,7 +5723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the access key IDs associated with the specified IAM user.\n If there is none, the operation returns an empty list.

\n

Although each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems and Marker parameters.

\n

If the UserName field is not specified, the user name is determined\n implicitly based on the Amazon Web Services access key ID used to sign the request. This operation\n works for access keys under the Amazon Web Services account. Consequently, you can use this operation\n to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no\n associated users.

\n \n

To ensure the security of your Amazon Web Services account, the secret access key is accessible\n only during key and user creation.

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

Returns information about the access key IDs associated with the specified IAM user.\n If there is none, the operation returns an empty list.

\n

Although each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems and Marker parameters.

\n

If the UserName is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required. This operation works for access keys\n under the Amazon Web Services account. Consequently, you can use this operation to manage\n Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n users.

\n \n

To ensure the security of your Amazon Web Services account, the secret access key is accessible\n only during key and user creation.

\n
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10370,7 +10370,7 @@ "ResourceHandlingOption": { "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { - "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and\n security-group resources. If your scenario includes an EBS volume, then you must specify\n that volume as a resource. If the EC2 scenario includes VPC, then you must supply the\n network-interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.

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

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.

\n " } }, "MaxItems": { @@ -10504,7 +10504,7 @@ "ResourceHandlingOption": { "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { - "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.

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

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.

\n " } }, "MaxItems": { @@ -11414,7 +11414,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the status of the specified access key from Active to Inactive, or vice versa.\n This operation can be used to disable a user's key as part of a key rotation\n workflow.

\n

If the UserName is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. This operation works for\n access keys under the Amazon Web Services account. Consequently, you can use this operation to manage\n Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n users.

\n

For information about rotating keys, see Managing keys and certificates\n in the IAM User Guide.

" + "smithy.api#documentation": "

Changes the status of the specified access key from Active to Inactive, or vice versa.\n This operation can be used to disable a user's key as part of a key rotation\n workflow.

\n

If the UserName is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required. This operation works for access keys\n under the Amazon Web Services account. Consequently, you can use this operation to manage\n Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n users.

\n

For information about rotating keys, see Managing keys and certificates\n in the IAM User Guide.

" } }, "com.amazonaws.iam#UpdateAccessKeyRequest": { diff --git a/codegen/sdk-codegen/aws-models/ivs.json b/codegen/sdk-codegen/aws-models/ivs.json index a900dcd77a9..054f57fca63 100644 --- a/codegen/sdk-codegen/aws-models/ivs.json +++ b/codegen/sdk-codegen/aws-models/ivs.json @@ -49,7 +49,7 @@ "date" ] }, - "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

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

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Amazon Resource Names (ARNs)\n

\n

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API calls. For more\n information, see Amazon Resource Names in the AWS General\n Reference.

\n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

\n ", "smithy.api#title": "Amazon Interactive Video Service" }, "version": "2020-07-14", @@ -323,7 +323,7 @@ "type": { "target": "com.amazonaws.ivs#ChannelType", "traits": { - "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:

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

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:

\n " } }, "recordingConfigurationArn": { @@ -572,7 +572,7 @@ "type": { "target": "com.amazonaws.ivs#ChannelType", "traits": { - "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:

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

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:

\n " } }, "authorized": { @@ -3017,7 +3017,7 @@ "type": { "target": "com.amazonaws.ivs#ChannelType", "traits": { - "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:

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

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:

\n " } }, "authorized": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 69a66718a76..593d3b150af 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -559,6 +559,21 @@ "smithy.api#documentation": "

Information about the dashboard that you want to embed.

" } }, + "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration": { "type": "structure", "members": { @@ -567,6 +582,12 @@ "traits": { "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } } }, "traits": { @@ -4048,6 +4069,35 @@ } } }, + "com.amazonaws.quicksight#DashboardVisualId": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", + "smithy.api#required": {} + } + }, + "SheetId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

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

A structure that contains the following elements:

\n \n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" + } + }, "com.amazonaws.quicksight#DataColorPalette": { "type": "structure", "members": { @@ -9449,7 +9499,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

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

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", @@ -9609,7 +9659,7 @@ "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.

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

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.

", "smithy.api#required": {} } }, @@ -9627,7 +9677,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard or console.

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

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.

", "smithy.api#required": {} } }, @@ -14696,6 +14746,21 @@ "smithy.api#documentation": "

Information about the dashboard you want to embed.

" } }, + "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration": { "type": "structure", "members": { @@ -14716,6 +14781,12 @@ "traits": { "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/transfer.json b/codegen/sdk-codegen/aws-models/transfer.json index 3e9d62a08b4..f0483129583 100644 --- a/codegen/sdk-codegen/aws-models/transfer.json +++ b/codegen/sdk-codegen/aws-models/transfer.json @@ -96,19 +96,19 @@ "LocalProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the AS2 process.

" + "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

" } }, "PartnerProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the partner for the connector.

" + "smithy.api#documentation": "

A unique identifier for the partner profile for the connector.

" } }, "MessageSubject": { "target": "com.amazonaws.transfer#MessageSubject", "traits": { - "smithy.api#documentation": "

A short description to help identify the connector.

" + "smithy.api#documentation": "

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

" } }, "Compression": { @@ -126,13 +126,13 @@ "SigningAlgorithm": { "target": "com.amazonaws.transfer#SigningAlg", "traits": { - "smithy.api#documentation": "

The algorithm that is used to sign the AS2 transfers for this partner profile.

" + "smithy.api#documentation": "

The algorithm that is used to sign the AS2 messages sent with the connector.

" } }, "MdnSigningAlgorithm": { "target": "com.amazonaws.transfer#MdnSigningAlg", "traits": { - "smithy.api#documentation": "

The signing algorithm for the MDN response.

" + "smithy.api#documentation": "

The signing algorithm for the MDN response.

\n \n

If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.

\n
" } }, "MdnResponse": { @@ -541,7 +541,7 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.

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

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s 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.

", "smithy.api#required": {} } }, @@ -682,7 +682,7 @@ "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The As2Id is the AS2-name, as defined in the defined in\n the 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 \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#required": {} } }, @@ -820,7 +820,7 @@ "Protocols": { "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

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

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n \n\n \n \n " } }, "ProtocolDetails": { @@ -2212,13 +2212,13 @@ "LocalProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the AS2 process.

" + "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

" } }, "PartnerProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the partner in the agreement.

" + "smithy.api#documentation": "

A unique identifier for the partner profile used in the agreement.

" } }, "BaseDirectory": { @@ -2230,7 +2230,7 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.

" + "smithy.api#documentation": "

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s 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.

" } }, "Tags": { @@ -2466,7 +2466,7 @@ "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the AS2 process.

" + "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.

" } }, "CertificateIds": { @@ -2550,7 +2550,7 @@ "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { - "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n

\n Use the PassiveIp parameter to indicate passive mode.\n Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.\n

" + "smithy.api#documentation": "

The protocol settings that are configured for your server.

\n " } }, "Domain": { @@ -2610,7 +2610,7 @@ "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 " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n \n\n \n \n " } }, "SecurityPolicyName": { @@ -4417,13 +4417,13 @@ "LocalProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the AS2 process.

" + "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

" } }, "PartnerProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

A unique identifier for the partner process.

" + "smithy.api#documentation": "

A unique identifier for the partner profile.

" } } }, @@ -4587,7 +4587,7 @@ "As2Id": { "target": "com.amazonaws.transfer#As2Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the AS2 process.

" + "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.

" } }, "ProfileType": { @@ -6115,7 +6115,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).\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 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\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 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#title": "AWS Transfer Family" }, "version": "2018-11-05", @@ -6487,13 +6487,13 @@ "LocalProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

To change the local profile identifier, provide a new value\n here.

" + "smithy.api#documentation": "

A unique identifier for the AS2 local profile.

\n

To change the local profile identifier, provide a new value\n here.

" } }, "PartnerProfileId": { "target": "com.amazonaws.transfer#ProfileId", "traits": { - "smithy.api#documentation": "

To change the partner profile identifier, provide a new value here.

" + "smithy.api#documentation": "

A unique identifier for the partner profile.\n To change the partner profile identifier, provide a new value here.

" } }, "BaseDirectory": { @@ -6505,7 +6505,7 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the \n HomeDirectory of your users' Amazon S3 buckets.

" + "smithy.api#documentation": "

With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s 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.

" } } } @@ -6821,7 +6821,7 @@ "Protocols": { "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n\n \n\n \n

If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate\n Manager (ACM) which will be 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 AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

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

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n \n\n \n \n " } }, "SecurityPolicyName": {