From 038d5d59d67cfea077ae7c786db7d9198a414eaf Mon Sep 17 00:00:00 2001 From: Matas Date: Thu, 29 Jun 2023 12:03:45 -0500 Subject: [PATCH 1/3] misc: sync AWS models and update smithy-kotlin (#967) --- .../f85d252e-e400-4b2e-b480-b5ca157555a5.json | 5 + codegen/sdk/aws-models/appfabric.json | 4172 +++++++++++++++++ codegen/sdk/aws-models/appflow.json | 7 + .../sdk/aws-models/chime-sdk-identity.json | 142 +- .../sdk/aws-models/chime-sdk-messaging.json | 88 +- codegen/sdk/aws-models/connect.json | 219 +- codegen/sdk/aws-models/devops-guru.json | 99 +- codegen/sdk/aws-models/emr-serverless.json | 32 +- codegen/sdk/aws-models/fsx.json | 128 +- codegen/sdk/aws-models/glue.json | 26 +- codegen/sdk/aws-models/guardduty.json | 15 +- codegen/sdk/aws-models/iam.json | 174 +- codegen/sdk/aws-models/internetmonitor.json | 64 + codegen/sdk/aws-models/ivs.json | 215 +- codegen/sdk/aws-models/kendra.json | 242 +- .../sdk/aws-models/kinesis-analytics-v2.json | 206 +- codegen/sdk/aws-models/kinesis-video.json | 567 ++- codegen/sdk/aws-models/lambda.json | 15 +- codegen/sdk/aws-models/macie2.json | 40 +- codegen/sdk/aws-models/omics.json | 90 +- codegen/sdk/aws-models/pinpoint.json | 35 + codegen/sdk/aws-models/privatenetworks.json | 229 +- codegen/sdk/aws-models/rds.json | 732 +-- codegen/sdk/aws-models/s3.json | 955 +--- .../sagemaker-featurestore-runtime.json | 118 +- codegen/sdk/aws-models/sagemaker.json | 103 +- codegen/sdk/aws-models/sfn.json | 1264 ++++- codegen/sdk/aws-models/ssm.json | 425 +- .../sdk/aws-models/verifiedpermissions.json | 114 +- gradle.properties | 4 +- 30 files changed, 8923 insertions(+), 1602 deletions(-) create mode 100644 .changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json create mode 100644 codegen/sdk/aws-models/appfabric.json diff --git a/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json b/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json new file mode 100644 index 00000000000..d94e49d1f4e --- /dev/null +++ b/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json @@ -0,0 +1,5 @@ +{ + "id": "f85d252e-e400-4b2e-b480-b5ca157555a5", + "type": "misc", + "description": "Sync AWS models and bump smithy-kotlin version" +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/appfabric.json b/codegen/sdk/aws-models/appfabric.json new file mode 100644 index 00000000000..b0fe02fb577 --- /dev/null +++ b/codegen/sdk/aws-models/appfabric.json @@ -0,0 +1,4172 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.appfabric#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You are not authorized to perform this operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.appfabric#ApiKeyCredential": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

An API key for an application.

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

Contains API key credential information.

" + } + }, + "com.amazonaws.appfabric#AppAuthorization": { + "type": "structure", + "members": { + "appAuthorizationArn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app authorization.

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

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

", + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "tenant": { + "target": "com.amazonaws.appfabric#Tenant", + "traits": { + "smithy.api#documentation": "

Contains information about an application tenant, such as the application display name\n and identifier.

", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.appfabric#AuthType", + "traits": { + "smithy.api#documentation": "

The authorization type.

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

The state of the app authorization.

\n

The following states are possible:

\n ", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.appfabric#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of when the app authorization was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.appfabric#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of when the app authorization was last updated.

", + "smithy.api#required": {} + } + }, + "persona": { + "target": "com.amazonaws.appfabric#Persona", + "traits": { + "smithy.api#documentation": "

The user persona of the app authorization.

\n

This field should always be admin.

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

The application URL for the OAuth flow.

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

Contains information about an app authorization.

" + } + }, + "com.amazonaws.appfabric#AppAuthorizationStatus": { + "type": "enum", + "members": { + "PENDING_CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingConnect" + } + }, + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Connected" + } + }, + "CONNECTION_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConnectionValidationFailed" + } + }, + "TOKEN_AUTO_ROTATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TokenAutoRotationFailed" + } + } + } + }, + "com.amazonaws.appfabric#AppAuthorizationSummary": { + "type": "structure", + "members": { + "appAuthorizationArn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app authorization.

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

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

", + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "tenant": { + "target": "com.amazonaws.appfabric#Tenant", + "traits": { + "smithy.api#documentation": "

Contains information about an application tenant, such as the application display name\n and identifier.

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

The state of the app authorization.

\n

The following states are possible:

\n ", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.appfabric#DateTime", + "traits": { + "smithy.api#documentation": "

Timestamp for when the app authorization was last updated.

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

Contains a summary of an app authorization.

" + } + }, + "com.amazonaws.appfabric#AppAuthorizationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#AppAuthorizationSummary" + } + }, + "com.amazonaws.appfabric#AppBundle": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app bundle.

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

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key\n used to encrypt the application data.

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

Contains information about an app bundle.

" + } + }, + "com.amazonaws.appfabric#AppBundleSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the app bundle.

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

Contains a summary of an app bundle.

" + } + }, + "com.amazonaws.appfabric#AppBundleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#AppBundleSummary" + } + }, + "com.amazonaws.appfabric#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:.+$" + } + }, + "com.amazonaws.appfabric#AuditLogDestinationConfiguration": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.appfabric#Destination", + "traits": { + "smithy.api#documentation": "

Contains information about an audit log destination.

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

Contains information about an audit log destination configuration.

" + } + }, + "com.amazonaws.appfabric#AuditLogProcessingConfiguration": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.appfabric#Schema", + "traits": { + "smithy.api#documentation": "

The event schema in which the audit logs need to be formatted.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appfabric#Format", + "traits": { + "smithy.api#documentation": "

The format in which the audit logs need to be formatted.

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

Contains information about an audit log processing configuration.

" + } + }, + "com.amazonaws.appfabric#AuthRequest": { + "type": "structure", + "members": { + "redirectUri": { + "target": "com.amazonaws.appfabric#RedirectUri", + "traits": { + "smithy.api#documentation": "

The redirect URL that is specified in the AuthURL and the application client.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The authorization code returned by the application after permission is granted in the\n application OAuth page (after clicking on the AuthURL).

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

Contains authorization request information, which is required for Amazon Web Services AppFabric to get the\n OAuth2 access token for an application.

" + } + }, + "com.amazonaws.appfabric#AuthType": { + "type": "enum", + "members": { + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "oauth2" + } + }, + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "apiKey" + } + } + } + }, + "com.amazonaws.appfabric#BatchGetUserAccessTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#BatchGetUserAccessTasksRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#BatchGetUserAccessTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets user access details in a batch request.

\n

This action polls data from the tasks that are kicked off by the\n StartUserAccessTasks action.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/useraccess/batchget" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#BatchGetUserAccessTasksRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#required": {} + } + }, + "taskIdList": { + "target": "com.amazonaws.appfabric#TaskIdList", + "traits": { + "smithy.api#documentation": "

The tasks IDs to use for the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#BatchGetUserAccessTasksResponse": { + "type": "structure", + "members": { + "userAccessResultsList": { + "target": "com.amazonaws.appfabric#UserAccessResultsList", + "traits": { + "smithy.api#documentation": "

Contains a list of user access results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource ID.

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

The resource type.

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

The request has created a conflict. Check the request parameters and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.appfabric#ConnectAppAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#ConnectAppAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#ConnectAppAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to\n call the APIs of the application.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}/connect" + } + } + }, + "com.amazonaws.appfabric#ConnectAppAuthorizationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n that contains the app authorization to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appAuthorizationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app\n authorization to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authRequest": { + "target": "com.amazonaws.appfabric#AuthRequest", + "traits": { + "smithy.api#documentation": "

Contains OAuth2 authorization information.

\n

This is required if the app authorization for the request is configured with an OAuth2\n (oauth2) authorization type.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#ConnectAppAuthorizationResponse": { + "type": "structure", + "members": { + "appAuthorizationSummary": { + "target": "com.amazonaws.appfabric#AppAuthorizationSummary", + "traits": { + "smithy.api#documentation": "

Contains a summary of the app authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#CreateAppAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#CreateAppAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#CreateAppAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an app authorization within an app bundle, which allows AppFabric to connect to an\n application.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#CreateAppAuthorizationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

\n

Valid values are:

\n ", + "smithy.api#required": {} + } + }, + "credential": { + "target": "com.amazonaws.appfabric#Credential", + "traits": { + "smithy.api#documentation": "

Contains credentials for the application, such as an API key or OAuth2 client ID and\n secret.

\n

Specify credentials that match the authorization type for your request. For example, if\n the authorization type for your request is OAuth2 (oauth2), then you should\n provide only the OAuth2 credentials.

", + "smithy.api#required": {} + } + }, + "tenant": { + "target": "com.amazonaws.appfabric#Tenant", + "traits": { + "smithy.api#documentation": "

Contains information about an application tenant, such as the application display name\n and identifier.

", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.appfabric#AuthType", + "traits": { + "smithy.api#documentation": "

The authorization type for the app authorization.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency\n of the request. This lets you safely retry the request without accidentally performing the\n same operation a second time. Passing the same value to a later call to an operation\n requires that you also pass the same value for all other parameters. We recommend that you\n use a UUID type of\n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with different\n parameters, the retry fails with an IdempotentParameterMismatch error.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.appfabric#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign to the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#CreateAppAuthorizationResponse": { + "type": "structure", + "members": { + "appAuthorization": { + "target": "com.amazonaws.appfabric#AppAuthorization", + "traits": { + "smithy.api#documentation": "

Contains information about an app authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#CreateAppBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#CreateAppBundleRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#CreateAppBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an app bundle to collect data from an application using AppFabric.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/appbundles" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#CreateAppBundleRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency\n of the request. This lets you safely retry the request without accidentally performing the\n same operation a second time. Passing the same value to a later call to an operation\n requires that you also pass the same value for all other parameters. We recommend that you\n use a UUID type of\n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with different\n parameters, the retry fails with an IdempotentParameterMismatch error.

", + "smithy.api#idempotencyToken": {} + } + }, + "customerManagedKeyIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to\n use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.

" + } + }, + "tags": { + "target": "com.amazonaws.appfabric#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign to the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#CreateAppBundleResponse": { + "type": "structure", + "members": { + "appBundle": { + "target": "com.amazonaws.appfabric#AppBundle", + "traits": { + "smithy.api#documentation": "

Contains information about an app bundle.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#CreateIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#CreateIngestionRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#CreateIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data ingestion for an application.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/ingestions" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#CreateIngestionDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#CreateIngestionDestinationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#CreateIngestionDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an ingestion destination, which specifies how an application's ingested data is\n processed by Amazon Web Services AppFabric and where it's delivered.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#CreateIngestionDestinationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "processingConfiguration": { + "target": "com.amazonaws.appfabric#ProcessingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about how ingested data is processed.

", + "smithy.api#required": {} + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.appfabric#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about the destination of ingested data.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency\n of the request. This lets you safely retry the request without accidentally performing the\n same operation a second time. Passing the same value to a later call to an operation\n requires that you also pass the same value for all other parameters. We recommend that you\n use a UUID type of\n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with different\n parameters, the retry fails with an IdempotentParameterMismatch error.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.appfabric#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign to the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#CreateIngestionDestinationResponse": { + "type": "structure", + "members": { + "ingestionDestination": { + "target": "com.amazonaws.appfabric#IngestionDestination", + "traits": { + "smithy.api#documentation": "

Contains information about an ingestion destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#CreateIngestionRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

\n

Valid values are:

\n ", + "smithy.api#required": {} + } + }, + "tenantId": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

", + "smithy.api#required": {} + } + }, + "ingestionType": { + "target": "com.amazonaws.appfabric#IngestionType", + "traits": { + "smithy.api#documentation": "

The ingestion type.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency\n of the request. This lets you safely retry the request without accidentally performing the\n same operation a second time. Passing the same value to a later call to an operation\n requires that you also pass the same value for all other parameters. We recommend that you\n use a UUID type of\n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with different\n parameters, the retry fails with an IdempotentParameterMismatch error.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.appfabric#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign to the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#CreateIngestionResponse": { + "type": "structure", + "members": { + "ingestion": { + "target": "com.amazonaws.appfabric#Ingestion", + "traits": { + "smithy.api#documentation": "

Contains information about an ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#Credential": { + "type": "union", + "members": { + "oauth2Credential": { + "target": "com.amazonaws.appfabric#Oauth2Credential", + "traits": { + "smithy.api#documentation": "

Contains OAuth2 client credential information.

" + } + }, + "apiKeyCredential": { + "target": "com.amazonaws.appfabric#ApiKeyCredential", + "traits": { + "smithy.api#documentation": "

Contains API key credential information.

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

Contains credential information for an application.

" + } + }, + "com.amazonaws.appfabric#DateTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.appfabric#DeleteAppAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#DeleteAppAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#DeleteAppAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an app authorization. You must delete the associated ingestion before you can\n delete an app authorization.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#DeleteAppAuthorizationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appAuthorizationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app\n authorization to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#DeleteAppAuthorizationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#DeleteAppBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#DeleteAppBundleRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#DeleteAppBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an app bundle. You must delete all associated app authorizations before you can\n delete an app bundle.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/appbundles/{appBundleIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#DeleteAppBundleRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#DeleteAppBundleResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#DeleteIngestionRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#DeleteIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all\n associated ingestion destinations before you can delete an app ingestion.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestionDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#DeleteIngestionDestinationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#DeleteIngestionDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an ingestion destination.

\n

This deletes the association between an ingestion and it's destination. It doesn't\n delete previously ingested data or the storage destination, such as the Amazon S3\n bucket where the data is delivered. If the ingestion destination is deleted while the\n associated ingestion is enabled, the ingestion will fail and is eventually disabled.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestionDestinationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionDestinationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion\n destination to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestionDestinationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestionRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#DeleteIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#Destination": { + "type": "union", + "members": { + "s3Bucket": { + "target": "com.amazonaws.appfabric#S3Bucket", + "traits": { + "smithy.api#documentation": "

Contains information about an Amazon S3 bucket.

" + } + }, + "firehoseStream": { + "target": "com.amazonaws.appfabric#FirehoseStream", + "traits": { + "smithy.api#documentation": "

Contains information about an Amazon Kinesis Data Firehose delivery stream.

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

Contains information about an audit log destination.

" + } + }, + "com.amazonaws.appfabric#DestinationConfiguration": { + "type": "union", + "members": { + "auditLog": { + "target": "com.amazonaws.appfabric#AuditLogDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about an audit log destination configuration.

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

Contains information about the destination of ingested data.

" + } + }, + "com.amazonaws.appfabric#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 320 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appfabric#FabricFrontEndService": { + "type": "service", + "version": "2023-05-19", + "operations": [ + { + "target": "com.amazonaws.appfabric#BatchGetUserAccessTasks" + }, + { + "target": "com.amazonaws.appfabric#ConnectAppAuthorization" + }, + { + "target": "com.amazonaws.appfabric#CreateAppAuthorization" + }, + { + "target": "com.amazonaws.appfabric#CreateAppBundle" + }, + { + "target": "com.amazonaws.appfabric#CreateIngestion" + }, + { + "target": "com.amazonaws.appfabric#CreateIngestionDestination" + }, + { + "target": "com.amazonaws.appfabric#DeleteAppAuthorization" + }, + { + "target": "com.amazonaws.appfabric#DeleteAppBundle" + }, + { + "target": "com.amazonaws.appfabric#DeleteIngestion" + }, + { + "target": "com.amazonaws.appfabric#DeleteIngestionDestination" + }, + { + "target": "com.amazonaws.appfabric#GetAppAuthorization" + }, + { + "target": "com.amazonaws.appfabric#GetAppBundle" + }, + { + "target": "com.amazonaws.appfabric#GetIngestion" + }, + { + "target": "com.amazonaws.appfabric#GetIngestionDestination" + }, + { + "target": "com.amazonaws.appfabric#ListAppAuthorizations" + }, + { + "target": "com.amazonaws.appfabric#ListAppBundles" + }, + { + "target": "com.amazonaws.appfabric#ListIngestionDestinations" + }, + { + "target": "com.amazonaws.appfabric#ListIngestions" + }, + { + "target": "com.amazonaws.appfabric#ListTagsForResource" + }, + { + "target": "com.amazonaws.appfabric#StartIngestion" + }, + { + "target": "com.amazonaws.appfabric#StartUserAccessTasks" + }, + { + "target": "com.amazonaws.appfabric#StopIngestion" + }, + { + "target": "com.amazonaws.appfabric#TagResource" + }, + { + "target": "com.amazonaws.appfabric#UntagResource" + }, + { + "target": "com.amazonaws.appfabric#UpdateAppAuthorization" + }, + { + "target": "com.amazonaws.appfabric#UpdateIngestionDestination" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "AppFabric", + "arnNamespace": "appfabric" + }, + "aws.auth#sigv4": { + "name": "appfabric" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your\n organization. This allows IT and security teams to easily manage and secure applications\n using a standard schema, and employees can complete everyday tasks faster using generative\n artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as\n setting up audit log ingestions or viewing user access. For more information about AppFabric,\n including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more\n information about using the Command Line Interface (CLI) to manage your\n AppFabric resources, see the AppFabric section of the CLI\n Reference.

", + "smithy.api#title": "AppFabric", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appfabric-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" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appfabric-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appfabric.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appfabric.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appfabric.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.appfabric#FirehoseStream": { + "type": "structure", + "members": { + "streamName": { + "target": "com.amazonaws.appfabric#String64", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis Data Firehose delivery stream.

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

Contains information about an Amazon Kinesis Data Firehose delivery stream.

" + } + }, + "com.amazonaws.appfabric#Format": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.appfabric#GetAppAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#GetAppAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#GetAppAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an app authorization.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#GetAppAuthorizationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appAuthorizationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app\n authorization to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#GetAppAuthorizationResponse": { + "type": "structure", + "members": { + "appAuthorization": { + "target": "com.amazonaws.appfabric#AppAuthorization", + "traits": { + "smithy.api#documentation": "

Contains information about an app authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#GetAppBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#GetAppBundleRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#GetAppBundleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an app bundle.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#GetAppBundleRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#GetAppBundleResponse": { + "type": "structure", + "members": { + "appBundle": { + "target": "com.amazonaws.appfabric#AppBundle", + "traits": { + "smithy.api#documentation": "

Contains information about an app bundle.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#GetIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#GetIngestionRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#GetIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an ingestion.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#GetIngestionDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#GetIngestionDestinationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#GetIngestionDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an ingestion destination.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#GetIngestionDestinationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionDestinationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion\n destination to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#GetIngestionDestinationResponse": { + "type": "structure", + "members": { + "ingestionDestination": { + "target": "com.amazonaws.appfabric#IngestionDestination", + "traits": { + "smithy.api#documentation": "

Contains information about an ingestion destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#GetIngestionRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#GetIngestionResponse": { + "type": "structure", + "members": { + "ingestion": { + "target": "com.amazonaws.appfabric#Ingestion", + "traits": { + "smithy.api#documentation": "

Contains information about an ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.appfabric#Ingestion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ingestion.

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

The Amazon Resource Name (ARN) of the app bundle for the ingestion.

", + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "tenantId": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

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

The timestamp of when the ingestion was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.appfabric#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of when the ingestion was last updated.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.appfabric#IngestionState", + "traits": { + "smithy.api#documentation": "

The status of the ingestion.

", + "smithy.api#required": {} + } + }, + "ingestionType": { + "target": "com.amazonaws.appfabric#IngestionType", + "traits": { + "smithy.api#documentation": "

The type of the ingestion.

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

Contains information about an ingestion.

" + } + }, + "com.amazonaws.appfabric#IngestionDestination": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ingestion destination.

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

The Amazon Resource Name (ARN) of the ingestion.

", + "smithy.api#required": {} + } + }, + "processingConfiguration": { + "target": "com.amazonaws.appfabric#ProcessingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about how ingested data is processed.

", + "smithy.api#required": {} + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.appfabric#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about the destination of ingested data.

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

The state of the ingestion destination.

\n

The following states are possible:

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

The reason for the current status of the ingestion destination.

\n

Only present when the status of ingestion destination is\n Failed.

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

The timestamp of when the ingestion destination was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.appfabric#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of when the ingestion destination was last updated.

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

Contains information about an ingestion destination.

" + } + }, + "com.amazonaws.appfabric#IngestionDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#IngestionDestinationSummary" + } + }, + "com.amazonaws.appfabric#IngestionDestinationStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.appfabric#IngestionDestinationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ingestion destination.

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

Contains a summary of an ingestion destination.

" + } + }, + "com.amazonaws.appfabric#IngestionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#IngestionSummary" + } + }, + "com.amazonaws.appfabric#IngestionState": { + "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.appfabric#IngestionSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ingestion.

", + "smithy.api#required": {} + } + }, + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "tenantId": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.appfabric#IngestionState", + "traits": { + "smithy.api#documentation": "

The status of the ingestion.

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

Contains a summary of an ingestion.

" + } + }, + "com.amazonaws.appfabric#IngestionType": { + "type": "enum", + "members": { + "AUDIT_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "auditLog" + } + } + } + }, + "com.amazonaws.appfabric#Integer": { + "type": "integer" + }, + "com.amazonaws.appfabric#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.appfabric#Integer", + "traits": { + "smithy.api#documentation": "

The period of time after which you should retry your request.

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

The request processing has failed because of an unknown error, exception, or failure\n with an internal server.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.appfabric#ListAppAuthorizations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#ListAppAuthorizationsRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#ListAppAuthorizationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all app authorizations configured for an app bundle.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "appAuthorizationSummaryList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#ListAppAuthorizationsRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.appfabric#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n nextToken to obtain further pages of results.

\n

This is only an upper limit. The actual number of results returned per call might be\n fewer than the specified maximum.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#ListAppAuthorizationsResponse": { + "type": "structure", + "members": { + "appAuthorizationSummaryList": { + "target": "com.amazonaws.appfabric#AppAuthorizationSummaryList", + "traits": { + "smithy.api#documentation": "

Contains a list of app authorization summaries.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#ListAppBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#ListAppBundlesRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#ListAppBundlesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of app bundles.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "appBundleSummaryList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#ListAppBundlesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.appfabric#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n nextToken to obtain further pages of results.

\n

This is only an upper limit. The actual number of results returned per call might be\n fewer than the specified maximum.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#ListAppBundlesResponse": { + "type": "structure", + "members": { + "appBundleSummaryList": { + "target": "com.amazonaws.appfabric#AppBundleSummaryList", + "traits": { + "smithy.api#documentation": "

Contains a list of app bundle summaries.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#ListIngestionDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#ListIngestionDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#ListIngestionDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all ingestion destinations configured for an ingestion.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestionDestinations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#ListIngestionDestinationsRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.appfabric#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n nextToken to obtain further pages of results.

\n

This is only an upper limit. The actual number of results returned per call might be\n fewer than the specified maximum.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#ListIngestionDestinationsResponse": { + "type": "structure", + "members": { + "ingestionDestinations": { + "target": "com.amazonaws.appfabric#IngestionDestinationList", + "traits": { + "smithy.api#documentation": "

Contains a list of ingestion destination summaries.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#ListIngestions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#ListIngestionsRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#ListIngestionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all ingestions configured for an app bundle.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/appbundles/{appBundleIdentifier}/ingestions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#ListIngestionsRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.appfabric#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n nextToken to obtain further pages of results.

\n

This is only an upper limit. The actual number of results returned per call might be\n fewer than the specified maximum.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#ListIngestionsResponse": { + "type": "structure", + "members": { + "ingestions": { + "target": "com.amazonaws.appfabric#IngestionList", + "traits": { + "smithy.api#documentation": "

Contains a list of ingestion summaries.

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

If nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.\n Each pagination token expires after 24 hours. Using an expired pagination token will return\n an HTTP 400 InvalidToken error.

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

Returns a list of tags for a resource.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.appfabric#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to retrieve\n tags.

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

A map of the key-value pairs for the tag or tags assigned to the specified resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.appfabric#Oauth2Credential": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.appfabric#String2048", + "traits": { + "smithy.api#documentation": "

The client ID of the client application.

", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The client secret of the client application.

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

Contains OAuth2 client credential information.

" + } + }, + "com.amazonaws.appfabric#Persona": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "admin" + } + }, + "ENDUSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "endUser" + } + } + } + }, + "com.amazonaws.appfabric#ProcessingConfiguration": { + "type": "union", + "members": { + "auditLog": { + "target": "com.amazonaws.appfabric#AuditLogProcessingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about an audit log processing configuration.

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

Contains information about how ingested data is processed.

" + } + }, + "com.amazonaws.appfabric#RedirectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^https://[-a-zA-Z0-9-._~:/?#@!$&'()*+,;=]+$" + } + }, + "com.amazonaws.appfabric#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource ID.

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

The resource type.

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

The specified resource does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.appfabric#ResultStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } + } + }, + "com.amazonaws.appfabric#S3Bucket": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.appfabric#String63", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.appfabric#String120", + "traits": { + "smithy.api#documentation": "

The object key to use.

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

Contains information about an Amazon S3 bucket.

" + } + }, + "com.amazonaws.appfabric#Schema": { + "type": "enum", + "members": { + "OCSF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ocsf" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "raw" + } + } + } + }, + "com.amazonaws.appfabric#SensitiveString2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appfabric#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource ID.

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

The resource type.

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

The code of the service.

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

The code for the quota exceeded.

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

The request exceeds a service quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.appfabric#StartIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#StartIngestionRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#StartIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts (enables) an ingestion, which collects data from an application.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/start" + } + } + }, + "com.amazonaws.appfabric#StartIngestionRequest": { + "type": "structure", + "members": { + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#StartIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#StartUserAccessTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#StartUserAccessTasksRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#StartUserAccessTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the tasks to search user access status for a specific email address.

\n

The tasks are stopped when the user access status data is found. The tasks are\n terminated when the API calls to the application time out.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/useraccess/start" + } + } + }, + "com.amazonaws.appfabric#StartUserAccessTasksRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

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

The email address of the target user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#StartUserAccessTasksResponse": { + "type": "structure", + "members": { + "userAccessTasksList": { + "target": "com.amazonaws.appfabric#UserAccessTasksList", + "traits": { + "smithy.api#documentation": "

Contains a list of user access task information.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#StopIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#StopIngestionRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#StopIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops (disables) an ingestion.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/stop" + } + } + }, + "com.amazonaws.appfabric#StopIngestionRequest": { + "type": "structure", + "members": { + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#StopIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#String120": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + } + } + }, + "com.amazonaws.appfabric#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.appfabric#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.appfabric#String63": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.appfabric#String64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.appfabric#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appfabric#TagKey", + "traits": { + "smithy.api#documentation": "

Tag key.

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

Tag value.

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

The key or keys of the key-value pairs for the tag or tags assigned to a\n resource.

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

Assigns one or more tags (key-value pairs) to the specified resource.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.appfabric#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

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

A map of the key-value pairs of the tag or tags to assign to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.appfabric#TaskError": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code of the error.

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

The message of the error.

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

Contains information about an error returned from a user access task.

" + } + }, + "com.amazonaws.appfabric#TaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#UUID" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appfabric#Tenant": { + "type": "structure", + "members": { + "tenantIdentifier": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

", + "smithy.api#required": {} + } + }, + "tenantDisplayName": { + "target": "com.amazonaws.appfabric#String2048", + "traits": { + "smithy.api#documentation": "

The display name of the tenant.

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

Contains information about an application tenant.

" + } + }, + "com.amazonaws.appfabric#TenantIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.appfabric#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code of the service.

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

The code for the quota exceeded.

" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.appfabric#Integer", + "traits": { + "smithy.api#documentation": "

The period of time after which you should retry your request.

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

The request rate exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.appfabric#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.appfabric#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag or tags from a resource.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.appfabric#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appfabric#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

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

The keys of the key-value pairs for the tag or tags you want to remove from the\n specified resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#UpdateAppAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#UpdateAppAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#UpdateAppAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an app authorization within an app bundle, which allows AppFabric to connect to an\n application.

\n

If the app authorization was in a connected state, updating the app\n authorization will set it back to a PendingConnect state.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}" + } + } + }, + "com.amazonaws.appfabric#UpdateAppAuthorizationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "appAuthorizationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app\n authorization to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "credential": { + "target": "com.amazonaws.appfabric#Credential", + "traits": { + "smithy.api#documentation": "

Contains credentials for the application, such as an API key or OAuth2 client ID and\n secret.

\n

Specify credentials that match the authorization type of the app authorization to\n update. For example, if the authorization type of the app authorization is OAuth2\n (oauth2), then you should provide only the OAuth2 credentials.

" + } + }, + "tenant": { + "target": "com.amazonaws.appfabric#Tenant", + "traits": { + "smithy.api#documentation": "

Contains information about an application tenant, such as the application display name\n and identifier.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#UpdateAppAuthorizationResponse": { + "type": "structure", + "members": { + "appAuthorization": { + "target": "com.amazonaws.appfabric#AppAuthorization", + "traits": { + "smithy.api#documentation": "

Contains information about an app authorization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#UpdateIngestionDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.appfabric#UpdateIngestionDestinationRequest" + }, + "output": { + "target": "com.amazonaws.appfabric#UpdateIngestionDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appfabric#AccessDeniedException" + }, + { + "target": "com.amazonaws.appfabric#ConflictException" + }, + { + "target": "com.amazonaws.appfabric#InternalServerException" + }, + { + "target": "com.amazonaws.appfabric#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appfabric#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appfabric#ThrottlingException" + }, + { + "target": "com.amazonaws.appfabric#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an ingestion destination, which specifies how an application's ingested data is\n processed by Amazon Web Services AppFabric and where it's delivered.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}" + } + } + }, + "com.amazonaws.appfabric#UpdateIngestionDestinationRequest": { + "type": "structure", + "members": { + "appBundleIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle\n to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to\n use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionDestinationIdentifier": { + "target": "com.amazonaws.appfabric#Identifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion\n destination to use for the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "destinationConfiguration": { + "target": "com.amazonaws.appfabric#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about the destination of ingested data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appfabric#UpdateIngestionDestinationResponse": { + "type": "structure", + "members": { + "ingestionDestination": { + "target": "com.amazonaws.appfabric#IngestionDestination", + "traits": { + "smithy.api#documentation": "

Contains information about an ingestion destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appfabric#UserAccessResultItem": { + "type": "structure", + "members": { + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "tenantId": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

" + } + }, + "tenantDisplayName": { + "target": "com.amazonaws.appfabric#String2048", + "traits": { + "smithy.api#documentation": "

The display name of the tenant.

" + } + }, + "taskId": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the task.

" + } + }, + "resultStatus": { + "target": "com.amazonaws.appfabric#ResultStatus", + "traits": { + "smithy.api#documentation": "

The status of the user access result item.

\n

The following states are possible:

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

The email address of the target user.

" + } + }, + "userId": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The unique ID of user.

" + } + }, + "userFullName": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The full name of the user.

" + } + }, + "userFirstName": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The first name of the user.

" + } + }, + "userLastName": { + "target": "com.amazonaws.appfabric#SensitiveString2048", + "traits": { + "smithy.api#documentation": "

The last name of the user.

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

The status of the user returned by the application.

" + } + }, + "taskError": { + "target": "com.amazonaws.appfabric#TaskError", + "traits": { + "smithy.api#documentation": "

Contains information about an error returned from a user access task.

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

Contains information about a user's access to an application.

" + } + }, + "com.amazonaws.appfabric#UserAccessResultsList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#UserAccessResultItem" + } + }, + "com.amazonaws.appfabric#UserAccessTaskItem": { + "type": "structure", + "members": { + "app": { + "target": "com.amazonaws.appfabric#String255", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "tenantId": { + "target": "com.amazonaws.appfabric#TenantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the application tenant.

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.appfabric#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the task.

" + } + }, + "error": { + "target": "com.amazonaws.appfabric#TaskError", + "traits": { + "smithy.api#documentation": "

Error from the task, if any.

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

Contains information about a user access task.

" + } + }, + "com.amazonaws.appfabric#UserAccessTasksList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#UserAccessTaskItem" + } + }, + "com.amazonaws.appfabric#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.appfabric#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the exception.

", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.appfabric#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The field list.

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

The request has invalid or missing parameters.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appfabric#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The field name where the invalid entry was detected.

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

A message about the validation exception.

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

The input failed to meet the constraints specified by the Amazon Web Services service in\n a specified field.

" + } + }, + "com.amazonaws.appfabric#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.appfabric#ValidationExceptionField" + } + }, + "com.amazonaws.appfabric#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/appflow.json b/codegen/sdk/aws-models/appflow.json index 0e172cdfce1..89a6e95c9a7 100644 --- a/codegen/sdk/aws-models/appflow.json +++ b/codegen/sdk/aws-models/appflow.json @@ -7589,6 +7589,13 @@ "traits": { "smithy.api#documentation": "

The SAPOData OAuth properties required for OAuth type authentication.

" } + }, + "disableSSO": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If you set this parameter to true, Amazon AppFlow bypasses the single\n sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

\n

Whether you need this option depends on the types of credentials that you applied to \n your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO\n can prevent Amazon AppFlow from connecting to your account with your username and\n password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect\n successfully. However, if your profile uses OAuth credentials, this parameter has no\n affect.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/chime-sdk-identity.json b/codegen/sdk/aws-models/chime-sdk-identity.json index 92cf2b4b7af..13730f21b19 100644 --- a/codegen/sdk/aws-models/chime-sdk-identity.json +++ b/codegen/sdk/aws-models/chime-sdk-identity.json @@ -300,13 +300,13 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

" } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

" } @@ -368,13 +368,13 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

" } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

" } @@ -2015,7 +2015,7 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

", "smithy.api#httpLabel": {}, @@ -2023,7 +2023,7 @@ } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

", "smithy.api#httpLabel": {}, @@ -2325,7 +2325,7 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString1600", + "target": "com.amazonaws.chimesdkidentity#String1600", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

", "smithy.api#httpLabel": {}, @@ -2333,7 +2333,7 @@ } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

", "smithy.api#httpLabel": {}, @@ -2711,6 +2711,28 @@ "smithy.api#documentation": "

The details of a user or bot.

" } }, + "com.amazonaws.chimesdkidentity#InvokedBy": { + "type": "structure", + "members": { + "StandardMessages": { + "target": "com.amazonaws.chimesdkidentity#StandardMessages", + "traits": { + "smithy.api#documentation": "

Sets standard messages as the bot trigger. For standard messages:

\n ", + "smithy.api#required": {} + } + }, + "TargetedMessages": { + "target": "com.amazonaws.chimesdkidentity#TargetedMessages", + "traits": { + "smithy.api#documentation": "

Sets targeted messages as the bot trigger. For targeted messages:

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

Specifies the type of message that triggers a bot.

" + } + }, "com.amazonaws.chimesdkidentity#LexBotAliasArn": { "type": "string", "traits": { @@ -2727,8 +2749,13 @@ "RespondsTo": { "target": "com.amazonaws.chimesdkidentity#RespondsTo", "traits": { - "smithy.api#documentation": "

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

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

\n Deprecated. Use InvokedBy instead.

\n \n

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

" + } + }, + "InvokedBy": { + "target": "com.amazonaws.chimesdkidentity#InvokedBy", + "traits": { + "smithy.api#documentation": "

Specifies the type of message that triggers a bot.

" } }, "LexBotAliasArn": { @@ -3644,13 +3671,13 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

" } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

" } @@ -3729,17 +3756,6 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.chimesdkidentity#SensitiveString64": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": ".*", - "smithy.api#sensitive": {} - } - }, "com.amazonaws.chimesdkidentity#ServiceFailureException": { "type": "structure", "members": { @@ -3772,9 +3788,58 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.chimesdkidentity#StandardMessages": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "MENTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MENTIONS" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.chimesdkidentity#String": { "type": "string" }, + "com.amazonaws.chimesdkidentity#String1600": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.chimesdkidentity#String64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.chimesdkidentity#Tag": { "type": "structure", "members": { @@ -3903,6 +3968,23 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkidentity#TargetedMessages": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.chimesdkidentity#ThrottledClientException": { "type": "structure", "members": { @@ -4104,6 +4186,12 @@ "smithy.api#documentation": "

The metadata of the AppInstanceBot.

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

The configuration for the bot update.

" + } } }, "traits": { @@ -4255,7 +4343,7 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

", "smithy.api#httpLabel": {}, @@ -4263,7 +4351,7 @@ } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

", "smithy.api#httpLabel": {}, @@ -4291,13 +4379,13 @@ "type": "structure", "members": { "AppInstanceUserArn": { - "target": "com.amazonaws.chimesdkidentity#SensitiveChimeArn", + "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "

The ARN of the AppInstanceUser.

" } }, "EndpointId": { - "target": "com.amazonaws.chimesdkidentity#SensitiveString64", + "target": "com.amazonaws.chimesdkidentity#String64", "traits": { "smithy.api#documentation": "

The unique identifier of the AppInstanceUserEndpoint.

" } diff --git a/codegen/sdk/aws-models/chime-sdk-messaging.json b/codegen/sdk/aws-models/chime-sdk-messaging.json index f12f62da084..c8fc56f0bab 100644 --- a/codegen/sdk/aws-models/chime-sdk-messaging.json +++ b/codegen/sdk/aws-models/chime-sdk-messaging.json @@ -599,7 +599,7 @@ } ], "traits": { - "smithy.api#documentation": "

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

\n

You can return one of the following processing responses:

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

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

\n

You can return one of the following processing responses:

\n ", "smithy.api#http": { "method": "POST", "uri": "/channels/{ChannelArn}?operation=channel-flow-callback", @@ -874,7 +874,7 @@ "Content": { "target": "com.amazonaws.chimesdkmessaging#Content", "traits": { - "smithy.api#documentation": "

The message content.

" + "smithy.api#documentation": "

The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "Metadata": { @@ -935,7 +935,7 @@ "MessageAttributes": { "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", "traits": { - "smithy.api#documentation": "

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" + "smithy.api#documentation": "

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "SubChannelId": { @@ -947,7 +947,13 @@ "ContentType": { "target": "com.amazonaws.chimesdkmessaging#ContentType", "traits": { - "smithy.api#documentation": "

The content type of the channel message.

" + "smithy.api#documentation": "

The content type of the channel message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and \n application/amz-chime-lex-error for failure responses. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" + } + }, + "Target": { + "target": "com.amazonaws.chimesdkmessaging#TargetList", + "traits": { + "smithy.api#documentation": "

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.\n Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

" } } }, @@ -968,7 +974,7 @@ "Content": { "target": "com.amazonaws.chimesdkmessaging#NonEmptyContent", "traits": { - "smithy.api#documentation": "

The message content.

" + "smithy.api#documentation": "

The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "Metadata": { @@ -986,7 +992,7 @@ "MessageAttributes": { "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", "traits": { - "smithy.api#documentation": "

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" + "smithy.api#documentation": "

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "SubChannelId": { @@ -998,7 +1004,7 @@ "ContentType": { "target": "com.amazonaws.chimesdkmessaging#ContentType", "traits": { - "smithy.api#documentation": "

The content type of the call-back message.

" + "smithy.api#documentation": "

The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and \n application/amz-chime-lex-error for failure responses. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } } }, @@ -1064,7 +1070,7 @@ "Detail": { "target": "com.amazonaws.chimesdkmessaging#StatusDetail", "traits": { - "smithy.api#documentation": "

Contains more details about the messasge status.

" + "smithy.api#documentation": "

Contains more details about the message status.

" } } }, @@ -1084,7 +1090,7 @@ "Content": { "target": "com.amazonaws.chimesdkmessaging#Content", "traits": { - "smithy.api#documentation": "

The content of the message.

" + "smithy.api#documentation": "

The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "Metadata": { @@ -1139,13 +1145,19 @@ "MessageAttributes": { "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", "traits": { - "smithy.api#documentation": "

The message attribues listed in a the summary of a channel message.

" + "smithy.api#documentation": "

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" } }, "ContentType": { "target": "com.amazonaws.chimesdkmessaging#ContentType", "traits": { - "smithy.api#documentation": "

The content type of the channel messsage listed in the summary.

" + "smithy.api#documentation": "

The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and \n application/amz-chime-lex-error for failure responses. For more information, refer to \n Processing responses from an AppInstanceBot in the \n Amazon Chime SDK Messaging Developer Guide.

" + } + }, + "Target": { + "target": "com.amazonaws.chimesdkmessaging#TargetList", + "traits": { + "smithy.api#documentation": "

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.\n Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

" } } }, @@ -1330,7 +1342,7 @@ "LastMessageTimestamp": { "target": "com.amazonaws.chimesdkmessaging#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the last persistent message in a channel was sent.

" + "smithy.api#documentation": "

The time at which the last persistent message visible to the caller in a channel was sent.

" } } }, @@ -1524,7 +1536,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging.

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

The Amazon Chime SDK messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging.

", "smithy.api#title": "Amazon Chime SDK Messaging", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -2426,7 +2438,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.

\n

Channel flows process the following items:

\n
    \n
  1. \n

    New and updated messages

    \n
    2. \n
  2. \n

    Persistent and non-persistent messages

    \n
    3. \n
  3. \n

    The Standard message type

    \n
    4. \n
\n \n

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to \n Message types in the Amazon Chime developer guide.

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

Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.

\n

Channel flows process the following items:

\n
    \n
  1. \n

    New and updated messages

    \n
    2. \n
  2. \n

    Persistent and non-persistent messages

    \n
    3. \n
  3. \n

    The Standard message type

    \n
    4. \n
\n \n

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to \n Message types in the Amazon Chime developer guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/channel-flows", @@ -4165,7 +4177,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the membership preferences of an AppInstanceUser or AppInstanceBot \n for the specified channel. A user or a bot must be a member of the channel and own the membership to be able \n to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't \n retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the \n channel from which they are banned.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

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

Gets the membership preferences of an AppInstanceUser or AppInstanceBot \n for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. \n Users or bots in the AppInstanceAdmin and channel moderator roles can't \n retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the \n channel from which they are banned.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n ", "smithy.api#http": { "method": "GET", "uri": "/channels/{ChannelArn}/memberships/{MemberArn}/preferences", @@ -4353,7 +4365,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to \n retrieving message status if the event was not received because a client wasn't connected to a websocket.

\n

Messages can have any one of these statuses.

\n
\n
SENT
\n
\n

Message processed successfully

\n
\n
PENDING
\n
\n

Ongoing processing

\n
\n
FAILED
\n
\n

Processing failed

\n
\n
DENIED
\n
\n

Messasge denied by the processor

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

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to \n retrieving message status if the event was not received because a client wasn't connected to a websocket.

\n

Messages can have any one of these statuses.

\n
\n
SENT
\n
\n

Message processed successfully

\n
\n
PENDING
\n
\n

Ongoing processing

\n
\n
FAILED
\n
\n

Processing failed

\n
\n
DENIED
\n
\n

Message denied by the processor

\n
\n
\n \n \n ", "smithy.api#http": { "method": "GET", "uri": "/channels/{ChannelArn}/messages/{MessageId}?scope=message-status", @@ -4871,7 +4883,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. \n Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

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

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. \n Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n ", "smithy.api#http": { "method": "GET", "uri": "/channels?scope=app-instance-user-memberships", @@ -6210,7 +6222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the membership preferences of an AppInstanceUser or AppIntanceBot \n for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the \n membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set \n preferences for other users or users. Banned users or bots can't set membership preferences for the channel from \n which they are banned.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the ARN of an \n AppInstanceUser or AppInstanceBot that makes the API call as the value in the \n header.

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

Sets the membership preferences of an AppInstanceUser or AppInstanceBot \n for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the \n membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set \n preferences for other users. Banned users or bots can't set membership preferences for the channel from \n which they are banned.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the ARN of an \n AppInstanceUser or AppInstanceBot that makes the API call as the value in the \n header.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/channels/{ChannelArn}/memberships/{MemberArn}/preferences", @@ -6715,7 +6727,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a message to a particular channel that the member is a part of.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata.\n CONTROL messages can contain 30 bytes of data and no metadata.

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

Sends a message to a particular channel that the member is a part of.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n

Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, \n and you can use it in a variety of ways, such as containing a link to an attachment.

\n

\n CONTROL messages are limited to 30 bytes and do not contain metadata.

\n ", "smithy.api#http": { "method": "POST", "uri": "/channels/{ChannelArn}/messages", @@ -6737,14 +6749,14 @@ "Content": { "target": "com.amazonaws.chimesdkmessaging#NonEmptyContent", "traits": { - "smithy.api#documentation": "

The content of the message.

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

The content of the channel message.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.chimesdkmessaging#ChannelMessageType", "traits": { - "smithy.api#documentation": "

The type of message, STANDARD or CONTROL.

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

The type of message, STANDARD or CONTROL.

\n

\n STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, \n and you can use it in a variety of ways, such as containing a link to an attachment.

\n

\n CONTROL messages are limited to 30 bytes and do not contain metadata.

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

The content type of the channel message.

" } + }, + "Target": { + "target": "com.amazonaws.chimesdkmessaging#TargetList", + "traits": { + "smithy.api#documentation": "

The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages.\n Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see. \n

" + } } }, "traits": { @@ -7098,6 +7116,32 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmessaging#Target": { + "type": "structure", + "members": { + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the target channel member.

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

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.\n Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

" + } + }, + "com.amazonaws.chimesdkmessaging#TargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#Target" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.chimesdkmessaging#TargetMembershipsPerSubChannel": { "type": "integer", "traits": { @@ -7386,7 +7430,7 @@ "Content": { "target": "com.amazonaws.chimesdkmessaging#NonEmptyContent", "traits": { - "smithy.api#documentation": "

The content of the message being updated.

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

The content of the channel message.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index bcecafbbf24..24368b539ae 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -973,6 +973,9 @@ { "target": "com.amazonaws.connect#SearchQuickConnects" }, + { + "target": "com.amazonaws.connect#SearchResourceTags" + }, { "target": "com.amazonaws.connect#SearchRoutingProfiles" }, @@ -3055,7 +3058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call\n the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber\n operation.

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

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call\n the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber\n operation.

\n \n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "POST", "uri": "/phone-number/claim", @@ -17550,6 +17553,19 @@ } } }, + "com.amazonaws.connect#MaximumResultReturnedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

Maximum number (1000) of tags have been returned with current request. Consider \n changing request parameters to get more tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.connect#MediaConcurrencies": { "type": "list", "member": { @@ -21116,7 +21132,7 @@ } ], "traits": { - "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect console.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

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

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect console.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n \n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}", @@ -21353,6 +21369,20 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.connect#ResourceTagsSearchCriteria": { + "type": "structure", + "members": { + "TagSearchCondition": { + "target": "com.amazonaws.connect#TagSearchCondition", + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return tags.

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

The search criteria to be used to search tags.

" + } + }, "com.amazonaws.connect#ResourceType": { "type": "enum", "members": { @@ -21400,6 +21430,12 @@ } } }, + "com.amazonaws.connect#ResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#String" + } + }, "com.amazonaws.connect#ResumeContactRecording": { "type": "operation", "input": { @@ -22621,6 +22657,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#SearchResourceTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchResourceTagsRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchResourceTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#MaximumResultReturnedException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches tags used in an Amazon Connect instance using optional search criteria.

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-resource-tags", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchResourceTagsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon \n Resource Name (ARN) of the instance.

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

The list of resource types to be used to search tags from. If not provided or if any empty list \n is provided, this API will search from all supported resource types.

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

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

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The search criteria to be used to return tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchResourceTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.connect#TagsList", + "traits": { + "smithy.api#documentation": "

A list of tags used in the Amazon Connect instance.

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

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchRoutingProfiles": { "type": "operation", "input": { @@ -24693,6 +24832,15 @@ } } }, + "com.amazonaws.connect#TagKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, "com.amazonaws.connect#TagMap": { "type": "map", "key": { @@ -24792,6 +24940,58 @@ } } }, + "com.amazonaws.connect#TagSearchCondition": { + "type": "structure", + "members": { + "tagKey": { + "target": "com.amazonaws.connect#TagKeyString", + "traits": { + "smithy.api#documentation": "

The tag key used in the tag search condition.

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

The tag value used in the tag search condition.

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

The type of comparison to be made when evaluating the tag key in tag search condition.

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

The type of comparison to be made when evaluating the tag value in tag search condition.

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

The search criteria to be used to return tags.

" + } + }, + "com.amazonaws.connect#TagSet": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.connect#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key in the tagSet.

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

The tag value in the tagSet.

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

A tag set contains tag key and tag value.

" + } + }, "com.amazonaws.connect#TagValue": { "type": "string", "traits": { @@ -24801,6 +25001,21 @@ } } }, + "com.amazonaws.connect#TagValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#TagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagSet" + } + }, "com.amazonaws.connect#TaskActionDefinition": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/devops-guru.json b/codegen/sdk/aws-models/devops-guru.json index e5900faaff5..f6446d3d4f6 100644 --- a/codegen/sdk/aws-models/devops-guru.json +++ b/codegen/sdk/aws-models/devops-guru.json @@ -137,7 +137,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a notification channel to DevOps Guru. A notification channel is used to notify you\n\t\t\tabout important DevOps Guru events, such as when an insight is generated.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

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

Adds a notification channel to DevOps Guru. A notification channel is used to notify you\n\t\t\tabout important DevOps Guru events, such as when an insight is generated.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

", "smithy.api#http": { "method": "PUT", "uri": "/channels", @@ -3417,6 +3417,68 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.devopsguru#KMSKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.devopsguru#KMSServerSideEncryptionIntegration": { + "type": "structure", + "members": { + "KMSKeyId": { + "target": "com.amazonaws.devopsguru#KMSKeyId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDescribes the specified KMS key.\n\t\t

\n

To specify a KMS key, use its key ID, key ARN, \n\t\t\talias name, or alias ARN. When using an alias name,\n\t\t\tprefix it with \"alias/\". If you specify a predefined Amazon Web Services alias\n\t\t\t(an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an\n\t\t\tAmazon Web Services managed key and returns its KeyId and Arn in the response. \n\t\t\tTo specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

\n

Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

\n

Alias name: alias/ExampleAlias

\n

Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

" + } + }, + "OptInStatus": { + "target": "com.amazonaws.devopsguru#OptInStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled for customer managed keys.\n\t\t

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

\n\t\t\tThe type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.\n\t\t

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

\n\t\t\tInformation about the KMS encryption used with DevOps Guru.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#KMSServerSideEncryptionIntegrationConfig": { + "type": "structure", + "members": { + "KMSKeyId": { + "target": "com.amazonaws.devopsguru#KMSKeyId", + "traits": { + "smithy.api#documentation": "

\n\t\t\t\tDescribes the specified KMS key.

\n

To specify a KMS key, use its key ID, key ARN, \n\t\t\t\talias name, or alias ARN. When using an alias name,\n\t\t\t\tprefix it with \"alias/\". If you specify a predefined Amazon Web Services alias\n\t\t\t\t(an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an\n\t\t\t\tAmazon Web Services managed key and returns its KeyId and Arn in the response. \n\t\t\t\tTo specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

\n

Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

\n

Alias name: alias/ExampleAlias

\n

Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

" + } + }, + "OptInStatus": { + "target": "com.amazonaws.devopsguru#OptInStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled for KMS integration.\n\t\t

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

\n\t\t\tThe type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.\n\t\t

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

\n\t\t\tInformation about whether DevOps Guru is configured to encrypt server-side data using KMS. \n\t\t

" + } + }, "com.amazonaws.devopsguru#ListAnomaliesForInsight": { "type": "operation", "input": { @@ -4729,7 +4791,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a notification channel. A notification channel is used to notify\n\t\t\tyou when DevOps Guru creates an insight. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" + "smithy.api#documentation": "

Information about a notification channel. A notification channel is used to notify\n\t\t\tyou when DevOps Guru creates an insight. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" } }, "com.amazonaws.devopsguru#NotificationChannelConfig": { @@ -4738,7 +4800,7 @@ "Sns": { "target": "com.amazonaws.devopsguru#SnsChannelConfig", "traits": { - "smithy.api#documentation": "

Information about a notification channel configured in DevOps Guru to send notifications\n\t\t\twhen insights are created.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

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

Information about a notification channel configured in DevOps Guru to send notifications\n\t\t\twhen insights are created.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

", "smithy.api#required": {} } }, @@ -6921,6 +6983,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.devopsguru#ServerSideEncryptionType": { + "type": "enum", + "members": { + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" + } + }, + "AWS_OWNED_KMS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" + } + } + } + }, "com.amazonaws.devopsguru#ServiceCollection": { "type": "structure", "members": { @@ -7003,6 +7082,12 @@ "traits": { "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.\n\t\t

" } + }, + "KMSServerSideEncryption": { + "target": "com.amazonaws.devopsguru#KMSServerSideEncryptionIntegration", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to encrypt server-side data using KMS. \n\t\t

" + } } }, "traits": { @@ -7241,7 +7326,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" + "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor Amazon SNS topics.

\n

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" } }, "com.amazonaws.devopsguru#SsmOpsItemId": { @@ -7779,6 +7864,12 @@ "traits": { "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.\n\t\t

" } + }, + "KMSServerSideEncryption": { + "target": "com.amazonaws.devopsguru#KMSServerSideEncryptionIntegrationConfig", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to encrypt server-side data using KMS. \n\t\t

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/emr-serverless.json b/codegen/sdk/aws-models/emr-serverless.json index b74c3358d5e..9ae8499bdd1 100644 --- a/codegen/sdk/aws-models/emr-serverless.json +++ b/codegen/sdk/aws-models/emr-serverless.json @@ -28,7 +28,7 @@ "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { - "smithy.api#documentation": "

The EMR release associated with the application.

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

The Amazon EMR release associated with the application.

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

Information about an application. EMR Serverless uses applications to run jobs.

" + "smithy.api#documentation": "

Information about an application. Amazon EMR Serverless uses applications to run jobs.

" } }, "com.amazonaws.emrserverless#ApplicationArn": { @@ -272,7 +272,7 @@ "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { - "smithy.api#documentation": "

The EMR release associated with the application.

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

The Amazon EMR release associated with the application.

", "smithy.api#required": {} } }, @@ -428,7 +428,7 @@ "x-amz-apigw-id" ] }, - "smithy.api#documentation": "

Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless,\n you don’t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

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

Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless,\n you don’t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

\n ", "smithy.api#title": "EMR Serverless", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1358,7 +1358,7 @@ "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { - "smithy.api#documentation": "

The EMR release associated with the application.

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

The Amazon EMR release associated with the application.

", "smithy.api#required": {} } }, @@ -1832,7 +1832,7 @@ "imageUri": { "target": "com.amazonaws.emrserverless#ImageUri", "traits": { - "smithy.api#documentation": "

The URI of an image in the Amazon ECR registry. This field is required when you create a\n new application. If you leave this field blank in an update, Amazon EMR will remove the\n image configuration.

" + "smithy.api#documentation": "

The URI of an image in the Amazon ECR registry. This field is required when you create a\n new application. If you leave this field blank in an update, Amazon EMR will remove the\n image configuration.

" } } }, @@ -2028,7 +2028,7 @@ "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { - "smithy.api#documentation": "

The EMR release associated with the application your job is running on.

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

The Amazon EMR release associated with the application your job is running on.

", "smithy.api#required": {} } }, @@ -2076,12 +2076,12 @@ "billedResourceUtilization": { "target": "com.amazonaws.emrserverless#ResourceUtilization", "traits": { - "smithy.api#documentation": "

The aggregate vCPU, memory, and storage that AWS has billed for the job run. The billed\n resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB\n per worker. Note that billed resources do not include usage for idle pre-initialized\n workers.

" + "smithy.api#documentation": "

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job run. The billed\n resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB\n per worker. Note that billed resources do not include usage for idle pre-initialized\n workers.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an EMR Serverless application.

" + "smithy.api#documentation": "

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an Amazon EMR Serverless application.

" } }, "com.amazonaws.emrserverless#JobRunId": { @@ -2251,7 +2251,7 @@ "releaseLabel": { "target": "com.amazonaws.emrserverless#ReleaseLabel", "traits": { - "smithy.api#documentation": "

The EMR release associated with the application your job is running on.

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

The Amazon EMR release associated with the application your job is running on.

", "smithy.api#required": {} } }, @@ -2492,7 +2492,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

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

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3139,7 +3139,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

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

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3227,7 +3227,7 @@ "resourceArn": { "target": "com.amazonaws.emrserverless#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

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

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

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

The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.

" } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.

" + } } } }, diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index f14f6ae4301..c31ce03ce69 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1653,7 +1653,7 @@ "com.amazonaws.fsx#AutomaticBackupRetentionDays": { "type": "integer", "traits": { - "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 0.

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

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 30.

", "smithy.api#range": { "min": 0, "max": 90 @@ -2129,6 +2129,46 @@ ], "traits": { "smithy.api#documentation": "

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region\n (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five\n backup copy requests in progress to a single destination Region per account.

\n

You can use cross-Region backup copies for cross-Region disaster recovery. You can\n periodically take backups and copy them to another Region so that in the event of a\n disaster in the primary Region, you can restore from backup and recover availability\n quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently\n has three partitions: aws (Standard Regions), aws-cn (China\n Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

\n

You can also use backup copies to clone your file dataset to another Region or within\n the same Region.

\n

You can use the SourceRegion parameter to specify the Amazon Web Services Region\n from which the backup will be copied. For example, if you make the call from the\n us-west-1 Region and want to copy a backup from the us-east-2\n Region, you specify us-east-2 in the SourceRegion parameter\n to make a cross-Region copy. If you don't specify a Region, the backup copy is\n created in the same Region where the request is sent from (in-Region copy).

\n

For more information about creating backup copies, see Copying backups\n in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User\n Guide, and Copying backups in the Amazon FSx for OpenZFS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a backup", + "documentation": "This operation copies an Amazon FSx backup.", + "input": { + "SourceBackupId": "backup-03e3c82e0183b7b6b", + "SourceRegion": "us-east-2" + }, + "output": { + "Backup": { + "BackupId": "backup-0a3364eded1014b28", + "OwnerId": "123456789012", + "Lifecycle": "COPYING", + "Type": "USER_INITIATED", + "CreationTime": 1.617954808068E9, + "KmsKeyId": "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ], + "FileSystem": { + "FileSystemId": "fs-0498eed5fe91001ec", + "FileSystemType": "LUSTRE", + "StorageCapacity": 2400, + "StorageType": "SSD", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", + "LustreConfiguration": { + "WeeklyMaintenanceStartTime": "1:05:00", + "DeploymentType": "PERSISTENT_1", + "PerUnitStorageThroughput": 50, + "AutomaticBackupRetentionDays": 0 + } + } + } + } + } + ], "smithy.api#idempotent": {} } }, @@ -2868,7 +2908,10 @@ "target": "com.amazonaws.fsx#DailyTime" }, "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 0.

" + } }, "CopyTagsToBackups": { "target": "com.amazonaws.fsx#Flag", @@ -2990,7 +3033,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "

Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:

\n \n

For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.

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

Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:

\n \n

For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.

", "smithy.api#required": {} } }, @@ -3161,7 +3204,7 @@ "AutomaticBackupRetentionDays": { "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "

The number of days to retain automatic backups. The default is to retain backups for 7\n days. Setting this value to 0 disables the creation of automatic backups. The maximum\n retention period for backups is 90 days.

" + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 30.

" } }, "CopyTagsToBackups": { @@ -4378,6 +4421,19 @@ ], "traits": { "smithy.api#documentation": "

Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and\n its data is gone.

\n

The DeleteBackup call returns instantly. The backup won't show up in\n later DescribeBackups calls.

\n \n

The data in a deleted backup is also deleted and can't be recovered by any\n means.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a backup", + "documentation": "This operation deletes an Amazon FSx file system backup.", + "input": { + "BackupId": "backup-03e3c82e0183b7b6b" + }, + "output": { + "BackupId": "backup-03e3c82e0183b7b6b", + "Lifecycle": "DELETED" + } + } + ], "smithy.api#idempotent": {} } }, @@ -4609,6 +4665,19 @@ ], "traits": { "smithy.api#documentation": "

Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.

\n

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.

\n

By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.

\n

The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.

\n \n

If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).

\n \n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a file system", + "documentation": "This operation deletes an Amazon FSx file system.", + "input": { + "FileSystemId": "fs-0498eed5fe91001ec" + }, + "output": { + "FileSystemId": "fs-0498eed5fe91001ec", + "Lifecycle": "DELETING" + } + } + ], "smithy.api#idempotent": {} } }, @@ -7225,6 +7294,23 @@ ], "traits": { "smithy.api#documentation": "

Lists tags for Amazon FSx resources.

\n

When retrieving all tags, you can optionally specify the MaxResults\n parameter to limit the number of tags in a response. If more tags remain, Amazon FSx\n returns a NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.

\n

This action is used in an iterative process to retrieve a list of your tags.\n ListTagsForResource is called first without a\n NextTokenvalue. Then the action continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.

\n

When using this action, keep the following in mind:

\n ", + "smithy.api#examples": [ + { + "title": "To list tags for a resource", + "documentation": "This operation lists tags for an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec" + }, + "output": { + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9713,6 +9799,21 @@ ], "traits": { "smithy.api#documentation": "

Tags an Amazon FSx resource.

", + "smithy.api#examples": [ + { + "title": "To tag a resource", + "documentation": "This operation tags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + } + ], "smithy.api#idempotent": {} } }, @@ -9894,6 +9995,18 @@ ], "traits": { "smithy.api#documentation": "

This action removes a tag from an Amazon FSx resource.

", + "smithy.api#examples": [ + { + "title": "To untag a resource", + "documentation": "This operation untags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "TagKeys": [ + "Name" + ] + } + } + ], "smithy.api#idempotent": {} } }, @@ -10144,7 +10257,10 @@ "target": "com.amazonaws.fsx#DailyTime" }, "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "traits": { + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 0.

" + } }, "AutoImportPolicy": { "target": "com.amazonaws.fsx#AutoImportPolicyType", @@ -10340,7 +10456,7 @@ "AutomaticBackupRetentionDays": { "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily\n backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see\n Working with Automatic Daily Backups.

" + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this property to\n 0 disables automatic backups. You can retain automatic backups for a\n maximum of 90 days. The default is 30. For more information, see\n Working with Automatic Daily Backups.

" } }, "ThroughputCapacity": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 70747ef8865..cf96976a477 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -19969,6 +19969,12 @@ "smithy.api#default": false } }, + "com.amazonaws.glue#Iso8601DateTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.glue#JDBCConnectionType": { "type": "enum", "members": { @@ -21411,6 +21417,12 @@ "traits": { "smithy.api#documentation": "

When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is \"glue.driver.streaming.maxConsumerLagInMs\". The default value is 'false'. This option is supported in Glue version 4.0 or later.

" } + }, + "StartingTimestamp": { + "target": "com.amazonaws.glue#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: \"2023-04-04T08:00:00+08:00\").

\n

Only one of StartingTimestamp or StartingOffsets must be set.

" + } } }, "traits": { @@ -21501,7 +21513,7 @@ "StartingPosition": { "target": "com.amazonaws.glue#StartingPosition", "traits": { - "smithy.api#documentation": "

The starting position in the Kinesis data stream to read data from. The possible values are \"latest\", \"trim_horizon\", or \"earliest\". The default value is \"latest\".

" + "smithy.api#documentation": "

The starting position in the Kinesis data stream to read data from. The possible values are \"latest\", \"trim_horizon\", \"earliest\", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: \"2023-04-04T08:00:00-04:00\"). The default value is \"latest\".

\n

Note: Using a value that is a timestamp string in UTC format for \"startingPosition\" is supported only for Glue version 4.0 or later.

" } }, "MaxFetchTimeInMs": { @@ -21593,6 +21605,12 @@ "traits": { "smithy.api#documentation": "

When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is \"glue.driver.streaming.maxConsumerLagInMs\". The default value is 'false'. This option is supported in Glue version 4.0 or later.

" } + }, + "StartingTimestamp": { + "target": "com.amazonaws.glue#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: \"2023-04-04T08:00:00+08:00\").

" + } } }, "traits": { @@ -29962,6 +29980,12 @@ "traits": { "smithy.api#enumValue": "earliest" } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "timestamp" + } } } }, diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index e3faf72bfb2..77f2357fd5b 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -7902,6 +7902,13 @@ "smithy.api#documentation": "

The groups that include the user who called the Kubernetes API.

", "smithy.api#jsonName": "groups" } + }, + "SessionName": { + "target": "com.amazonaws.guardduty#SessionNameList", + "traits": { + "smithy.api#documentation": "

Entity that assumes the IAM role \n when Kubernetes RBAC permissions are assigned to that role.

", + "smithy.api#jsonName": "sessionName" + } } }, "traits": { @@ -8931,7 +8938,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this\n operation returns all assigned tags for a given resource.

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

Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, publishing destination, with a limit of 50 tags per resource. When invoked, this\n operation returns all assigned tags for a given resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -11772,6 +11779,12 @@ "smithy.api#documentation": "

Additional information about the generated finding.

" } }, + "com.amazonaws.guardduty#SessionNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, "com.amazonaws.guardduty#SortCriteria": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/iam.json b/codegen/sdk/aws-models/iam.json index 3f222206c62..d5bcccaa08a 100644 --- a/codegen/sdk/aws-models/iam.json +++ b/codegen/sdk/aws-models/iam.json @@ -222,6 +222,9 @@ { "target": "com.amazonaws.iam#GetLoginProfile" }, + { + "target": "com.amazonaws.iam#GetMFADevice" + }, { "target": "com.amazonaws.iam#GetOpenIDConnectProvider" }, @@ -2128,7 +2131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM group.

\n

You use this operation to attach a managed policy to a group. To embed an inline\n policy in a group, use PutGroupPolicy.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" + "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM group.

\n

You use this operation to attach a managed policy to a group. To embed an inline\n policy in a group, use \n PutGroupPolicy\n .

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" } }, "com.amazonaws.iam#AttachGroupPolicyRequest": { @@ -2182,7 +2185,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM role. When you attach a\n managed policy to a role, the managed policy becomes part of the role's permission\n (access) policy.

\n \n

You cannot use a managed policy as the role's trust policy. The role's trust\n policy is created at the same time as the role, using CreateRole.\n You can update a role's trust policy using UpdateAssumeRolePolicy.

\n \n

Use this operation to attach a managed policy to a role. To embed\n an inline policy in a role, use PutRolePolicy. For more information\n about policies, see Managed policies and inline\n policies in the IAM User Guide.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

" + "smithy.api#documentation": "

Attaches the specified managed policy to the specified IAM role. When you attach a\n managed policy to a role, the managed policy becomes part of the role's permission\n (access) policy.

\n \n

You cannot use a managed policy as the role's trust policy. The role's trust\n policy is created at the same time as the role, using \n CreateRole\n . You can update a role's trust policy using\n \n UpdateAssumerolePolicy\n .

\n \n

Use this operation to attach a managed policy to a role. To embed\n an inline policy in a role, use \n PutRolePolicy\n . For more information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

" } }, "com.amazonaws.iam#AttachRolePolicyRequest": { @@ -2233,7 +2236,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches the specified managed policy to the specified user.

\n

You use this operation to attach a managed policy to a user. To\n embed an inline policy in a user, use PutUserPolicy.

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" + "smithy.api#documentation": "

Attaches the specified managed policy to the specified user.

\n

You use this operation to attach a managed policy to a user. To\n embed an inline policy in a user, use \n PutUserPolicy\n .

\n

As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.

\n

For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.

" } }, "com.amazonaws.iam#AttachUserPolicyRequest": { @@ -2301,6 +2304,35 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.iam#CertificationKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.iam#CertificationMapType": { + "type": "map", + "key": { + "target": "com.amazonaws.iam#CertificationKeyType" + }, + "value": { + "target": "com.amazonaws.iam#CertificationValueType" + } + }, + "com.amazonaws.iam#CertificationValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, "com.amazonaws.iam#ChangePassword": { "type": "operation", "input": { @@ -5941,6 +5973,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.iam#GetMFADevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iam#GetMFADeviceRequest" + }, + "output": { + "target": "com.amazonaws.iam#GetMFADeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iam#NoSuchEntityException" + }, + { + "target": "com.amazonaws.iam#ServiceFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an MFA device for a specified user.

" + } + }, + "com.amazonaws.iam#GetMFADeviceRequest": { + "type": "structure", + "members": { + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.

", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iam#GetMFADeviceResponse": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" + } + }, + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", + "traits": { + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.

", + "smithy.api#required": {} + } + }, + "EnableDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date that a specified user's MFA device was first enabled.

" + } + }, + "Certifications": { + "target": "com.amazonaws.iam#CertificationMapType", + "traits": { + "smithy.api#documentation": "

The certifications of a specified user's MFA device. We currently provide FIPS-140-2, FIPS-140-3, and FIDO certification levels\n obtained from FIDO Alliance Metadata Service (MDS).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iam#GetOpenIDConnectProvider": { "type": "operation", "input": { @@ -8082,7 +8188,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListInstanceProfileTagsRequest": { @@ -8320,7 +8432,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListMFADeviceTagsRequest": { @@ -8479,7 +8597,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible\n identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible\n identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListOpenIDConnectProviderTagsRequest": { @@ -8788,7 +8912,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM customer managed policy.\n The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM customer managed policy.\n The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListPolicyTagsRequest": { @@ -9029,7 +9159,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified role. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified role. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListRoleTagsRequest": { @@ -9185,7 +9321,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified Security Assertion Markup Language\n (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

" + "smithy.api#documentation": "

Lists the tags that are attached to the specified Security Assertion Markup Language\n (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based\n federation.

\n

For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListSAMLProviderTagsRequest": { @@ -9376,7 +9518,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags that are attached to the specified IAM server certificate. The\n returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

For certificates in a Region supported by Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.

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

Lists the tags that are attached to the specified IAM server certificate. The\n returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.

\n \n

For certificates in a Region supported by Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Tags", + "pageSize": "MaxItems" + } } }, "com.amazonaws.iam#ListServerCertificateTagsRequest": { @@ -10734,7 +10882,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n group.

\n

A user can also have managed policies attached to it. To attach a managed policy to a\n group, use AttachGroupPolicy. To create a new managed policy, use\n CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n group, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutGroupPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

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

Adds or updates an inline policy document that is embedded in the specified IAM\n group.

\n

A user can also have managed policies attached to it. To attach a managed policy to a\n group, use \n AttachGroupPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n group, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutGroupPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n " } }, "com.amazonaws.iam#PutGroupPolicyRequest": { @@ -10843,7 +10991,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n role.

\n

When you embed an inline policy in a role, the inline policy is used as part of the\n role's access (permissions) policy. The role's trust policy is created at the same time\n as the role, using CreateRole. You can update a role's trust policy\n using UpdateAssumeRolePolicy. For more information about IAM roles,\n see Using roles to\n delegate permissions and federate identities.

\n

A role can also have a managed policy attached to it. To attach a managed policy to a\n role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed with a\n role, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutRolePolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

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

Adds or updates an inline policy document that is embedded in the specified IAM\n role.

\n

When you embed an inline policy in a role, the inline policy is used as part of the\n role's access (permissions) policy. The role's trust policy is created at the same time\n as the role, using \n CreateRole\n .\n You can update a role's trust policy using \n UpdateAssumerolePolicy\n . For more information about IAM\n roles, see Using\n roles to delegate permissions and federate identities.

\n

A role can also have a managed policy attached to it. To attach a managed policy to a\n role, use \n AttachRolePolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed with a\n role, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutRolePolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n " } }, "com.amazonaws.iam#PutRolePolicyRequest": { @@ -10946,7 +11094,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates an inline policy document that is embedded in the specified IAM\n user.

\n

An IAM user can also have a managed policy attached to it. To attach a managed\n policy to a user, use AttachUserPolicy. To create a new managed\n policy, use CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n user, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutUserPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

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

Adds or updates an inline policy document that is embedded in the specified IAM\n user.

\n

An IAM user can also have a managed policy attached to it. To attach a managed\n policy to a user, use \n AttachUserPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.

\n

For information about the maximum number of inline policies that you can embed in a\n user, see IAM and STS quotas in the IAM User Guide.

\n \n

Because policy documents can be large, you should use POST rather than GET when\n calling PutUserPolicy. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.

\n " } }, "com.amazonaws.iam#PutUserPolicyRequest": { diff --git a/codegen/sdk/aws-models/internetmonitor.json b/codegen/sdk/aws-models/internetmonitor.json index a8227e04a56..7bd1fc71097 100644 --- a/codegen/sdk/aws-models/internetmonitor.json +++ b/codegen/sdk/aws-models/internetmonitor.json @@ -165,6 +165,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" } + }, + "HealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#HealthEventsConfig", + "traits": { + "smithy.api#documentation": "

Defines the health event threshold percentages, for performance score and availability score. Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default calue is 95%.

" + } } } }, @@ -360,6 +366,13 @@ "smithy.api#documentation": "

The type of impairment of a specific health event.

", "smithy.api#required": {} } + }, + "HealthScoreThreshold": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The threshold percentage for health events when Amazon CloudWatch Internet Monitor creates a health event.

" + } } } }, @@ -491,6 +504,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" } + }, + "HealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#HealthEventsConfig", + "traits": { + "smithy.api#documentation": "

The list of health event thresholds. A health event threshold percentage, for performance and availability, determines the level\n\t\t\tof impact at which Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that affects your application end users.

" + } } } }, @@ -567,6 +586,13 @@ "smithy.api#documentation": "

The type of impairment for a health event.

", "smithy.api#required": {} } + }, + "HealthScoreThreshold": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.

" + } } }, "traits": { @@ -642,6 +668,28 @@ ] } }, + "com.amazonaws.internetmonitor#HealthEventsConfig": { + "type": "structure", + "members": { + "AvailabilityScoreThreshold": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The health event threshold percentage set for availability scores.

" + } + }, + "PerformanceScoreThreshold": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The health event threshold percentage set for performance scores.

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

A complex type for the configuration. Defines the health event threshold percentages, for performance score and availability score. Amazon CloudWatch Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default value is 95%.

" + } + }, "com.amazonaws.internetmonitor#ImpactedLocation": { "type": "structure", "members": { @@ -1784,6 +1832,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.internetmonitor#Percentage": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.internetmonitor#PerformanceMeasurement": { "type": "structure", "members": { @@ -2242,6 +2300,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" } + }, + "HealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#HealthEventsConfig", + "traits": { + "smithy.api#documentation": "

The list of health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates \n\t\t\ta health event when there's an internet issue that affects your application end users.

" + } } } }, diff --git a/codegen/sdk/aws-models/ivs.json b/codegen/sdk/aws-models/ivs.json index fbc583a869d..eb20375f823 100644 --- a/codegen/sdk/aws-models/ivs.json +++ b/codegen/sdk/aws-models/ivs.json @@ -27,6 +27,9 @@ { "target": "com.amazonaws.ivs#BatchGetStreamKey" }, + { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocation" + }, { "target": "com.amazonaws.ivs#CreateChannel" }, @@ -93,6 +96,9 @@ { "target": "com.amazonaws.ivs#PutMetadata" }, + { + "target": "com.amazonaws.ivs#StartViewerSessionRevocation" + }, { "target": "com.amazonaws.ivs#StopStream" }, @@ -136,7 +142,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 a 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#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 a 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 Private Channel 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", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1041,6 +1047,132 @@ } } }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationRequest" + }, + "output": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Performs StartViewerSessionRevocation on multiple channel ARN and viewer\n ID pairs simultaneously.

", + "smithy.api#http": { + "method": "POST", + "uri": "/BatchStartViewerSessionRevocation" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationError": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

Channel ARN.

", + "smithy.api#required": {} + } + }, + "viewerId": { + "target": "com.amazonaws.ivs#ViewerId", + "traits": { + "smithy.api#documentation": "

The ID of the viewer session to revoke.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.ivs#errorCode", + "traits": { + "smithy.api#documentation": "

Error code.

" + } + }, + "message": { + "target": "com.amazonaws.ivs#errorMessage", + "traits": { + "smithy.api#documentation": "

Error message, determined by the application.

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

Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is\n related to a specific channel-ARN and viewer-ID pair.

" + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationError" + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationRequest": { + "type": "structure", + "members": { + "viewerSessions": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationViewerSessionList", + "traits": { + "smithy.api#documentation": "

Array of viewer sessions, one per channel-ARN and viewer-ID pair.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationErrors", + "traits": { + "smithy.api#documentation": "

Each error object is related to a specific channelArn and\n viewerId pair in the request.

" + } + } + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationViewerSession": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel associated with the viewer session to revoke.

", + "smithy.api#required": {} + } + }, + "viewerId": { + "target": "com.amazonaws.ivs#ViewerId", + "traits": { + "smithy.api#documentation": "

The ID of the viewer associated with the viewer session to revoke. Do not use this field\n for personally identifying, confidential, or sensitive information.

", + "smithy.api#required": {} + } + }, + "viewerSessionVersionsLessThanOrEqualTo": { + "target": "com.amazonaws.ivs#ViewerSessionVersion", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An optional filter on which versions of the viewer session to revoke. All versions less\n than or equal to the specified version will be revoked. Default: 0.

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

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

" + } + }, + "com.amazonaws.ivs#BatchStartViewerSessionRevocationViewerSessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#BatchStartViewerSessionRevocationViewerSession" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.ivs#Boolean": { "type": "boolean", "traits": { @@ -3151,6 +3283,67 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.ivs#StartViewerSessionRevocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#StartViewerSessionRevocationRequest" + }, + "output": { + "target": "com.amazonaws.ivs#StartViewerSessionRevocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#InternalServerException" + }, + { + "target": "com.amazonaws.ivs#ThrottlingException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the process of revoking the viewer session associated with a specified channel ARN\n and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and\n including that version. For instructions on associating a viewer ID with a viewer session, see\n Setting Up\n Private Channels.

", + "smithy.api#http": { + "method": "POST", + "uri": "/StartViewerSessionRevocation" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivs#StartViewerSessionRevocationRequest": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel associated with the viewer session to revoke.

", + "smithy.api#required": {} + } + }, + "viewerId": { + "target": "com.amazonaws.ivs#ViewerId", + "traits": { + "smithy.api#documentation": "

The ID of the viewer associated with the viewer session to revoke. Do not use this field\n for personally identifying, confidential, or sensitive information.

", + "smithy.api#required": {} + } + }, + "viewerSessionVersionsLessThanOrEqualTo": { + "target": "com.amazonaws.ivs#ViewerSessionVersion", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An optional filter on which versions of the viewer session to revoke. All versions less\n than or equal to the specified version will be revoked. Default: 0.

" + } + } + } + }, + "com.amazonaws.ivs#StartViewerSessionRevocationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.ivs#StopStream": { "type": "operation", "input": { @@ -3926,7 +4119,7 @@ "preset": { "target": "com.amazonaws.ivs#TranscodePreset", "traits": { - "smithy.api#documentation": "

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and\n ADVANCED_SD channel types. For those channel types, the default preset is\n HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty\n string (\"\").

" + "smithy.api#documentation": "

Optional transcode preset for the channel. This is selectable only for\n ADVANCED_HD and ADVANCED_SD channel types. For those channel\n types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other\n channel types (BASIC and STANDARD), preset is the empty\n string (\"\").

" } } } @@ -4015,6 +4208,24 @@ "smithy.api#documentation": "

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in\n an encoder). This is part of the IngestConfiguration object and used for\n monitoring stream health.

" } }, + "com.amazonaws.ivs#ViewerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.ivs#ViewerSessionVersion": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.ivs#errorCode": { "type": "string" }, diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 9968e83bd64..23d0c050792 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -189,6 +189,9 @@ { "target": "com.amazonaws.kendra#Query" }, + { + "target": "com.amazonaws.kendra#Retrieve" + }, { "target": "com.amazonaws.kendra#StartDataSourceSyncJob" }, @@ -1271,7 +1274,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your data\n source.

\n \n

Alfresco data source connector is currently in preview mode. Basic authentication\n is currently supported. If you would like to use Alfresco connector in production,\n contact Support.

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

Provides the configuration information to connect to Alfresco as your data\n source.

\n \n

Support for AlfrescoConfiguration ended May 2023. \n We recommend migrating to or using the Alfresco data source template \n schema / TemplateConfiguration API.

\n " } }, "com.amazonaws.kendra#AlfrescoEntity": { @@ -3177,6 +3180,9 @@ "smithy.api#documentation": "

Provides the configuration information that's required to connect to a\n database.

" } }, + "com.amazonaws.kendra#Content": { + "type": "string" + }, "com.amazonaws.kendra#ContentSourceConfiguration": { "type": "structure", "members": { @@ -3740,7 +3746,7 @@ "FileFormat": { "target": "com.amazonaws.kendra#FaqFileFormat", "traits": { - "smithy.api#documentation": "

The format of the FAQ input file. You can choose between a basic CSV format, a CSV\n format that includes customs attributes in a header, and a JSON format that includes\n custom attributes.

\n

The format must match the format of the file stored in the S3 bucket identified in the\n S3Path parameter.

\n

For more information, see Adding questions and\n answers.

" + "smithy.api#documentation": "

The format of the FAQ input file. You can choose between a basic CSV format, a CSV\n format that includes customs attributes in a header, and a JSON format that includes\n custom attributes.

\n

The default format is CSV.

\n

The format must match the format of the file stored in the S3 bucket identified in \n the S3Path parameter.

\n

For more information, see Adding questions and\n answers.

" } }, "ClientToken": { @@ -4341,7 +4347,10 @@ "AlfrescoConfiguration": { "target": "com.amazonaws.kendra#AlfrescoConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your data source.

" + "smithy.api#deprecated": { + "message": "Deprecated AlfrescoConfiguration in favor of TemplateConfiguration" + }, + "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your data source.

\n

Support for AlfrescoConfiguration ended May 2023. \n We recommend migrating to or using the Alfresco data source template \n schema / TemplateConfiguration API.

" } }, "TemplateConfiguration": { @@ -4439,7 +4448,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 250 } } }, @@ -4448,7 +4457,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 150 + "max": 300 } } }, @@ -6895,7 +6904,7 @@ "ContentType": { "target": "com.amazonaws.kendra#ContentType", "traits": { - "smithy.api#documentation": "

The file type of the document in the Blob field.

" + "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 \n of the HTML documents, you must add the HTML start and closing tags \n (content) around the content.

" } }, "AccessControlConfigurationId": { @@ -7327,6 +7336,9 @@ "target": "com.amazonaws.kendra#Status" } }, + "com.amazonaws.kendra#DocumentTitle": { + "type": "string" + }, "com.amazonaws.kendra#DocumentsMetadataConfiguration": { "type": "structure", "members": { @@ -11646,7 +11658,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches an active index. Use this API to search your documents using query. The\n Query API enables to do faceted search and to filter results based on\n document attributes.

\n

It also enables you to provide user context that Amazon Kendra uses to enforce\n document access control in the search results.

\n

Amazon Kendra searches your index for text content and question and answer (FAQ)\n content. By default the response contains three types of results.

\n \n

You can specify that the query return only one type of result using the\n QueryResultTypeFilter parameter.

\n

Each query returns the 100 most relevant results.

" + "smithy.api#documentation": "

Searches an index given an input query.

\n

You can configure boosting or relevance tuning at the query level to override boosting \n at the index level, filter based on document fields/attributes and faceted search, and \n filter based on the user or their group access to documents. You can also include certain \n fields in the response that might provide useful additional information.

\n

A query response contains three types of results.

\n \n

You can specify that the query return only one type of result using the \n QueryResultTypeFilter parameter. Each query returns the 100 \n most relevant results. If you filter result type to only question-answers, \n a maximum of four results are returned. If you filter result type to only \n answers, a maximum of three results are returned.

" } }, "com.amazonaws.kendra#QueryCapacityUnit": { @@ -11690,7 +11702,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The identifier of the index to search. The identifier is returned in the response\n from the CreateIndex API.

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

The identifier of the index for the search.

", "smithy.api#required": {} } }, @@ -11703,37 +11715,37 @@ "AttributeFilter": { "target": "com.amazonaws.kendra#AttributeFilter", "traits": { - "smithy.api#documentation": "

Enables filtered searches based on document attributes. You can only provide one\n attribute filter; however, the AndAllFilters, NotFilter, and\n OrAllFilters parameters contain a list of other filters.

\n

The AttributeFilter parameter enables you to create a set of filtering\n rules that a document must satisfy to be included in the query results.

" + "smithy.api#documentation": "

Filters search results by document fields/attributes. You can only provide \n one attribute filter; however, the AndAllFilters, NotFilter, \n and OrAllFilters parameters contain a list of other filters.

\n

The AttributeFilter parameter means you can create a set of \n filtering rules that a document must satisfy to be included in the query results.

" } }, "Facets": { "target": "com.amazonaws.kendra#FacetList", "traits": { - "smithy.api#documentation": "

An array of documents attributes. Amazon Kendra returns a count for each attribute\n key specified. This helps your users narrow their search.

" + "smithy.api#documentation": "

An array of documents fields/attributes for faceted search. Amazon Kendra returns a \n count for each field key specified. This helps your users narrow their search.

" } }, "RequestedDocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeKeyList", "traits": { - "smithy.api#documentation": "

An array of document attributes to include in the response. You can limit the response\n to include certain document attributes. By default all document attributes are included in\n the response.

" + "smithy.api#documentation": "

An array of document fields/attributes to include in the response. You can limit the \n response to include certain document fields. By default, all document attributes are \n included in the response.

" } }, "QueryResultTypeFilter": { "target": "com.amazonaws.kendra#QueryResultType", "traits": { - "smithy.api#documentation": "

Sets the type of query. Only results for the specified query type are returned.

" + "smithy.api#documentation": "

Sets the type of query result or response. Only results for the specified type are \n returned.

" } }, "DocumentRelevanceOverrideConfigurations": { "target": "com.amazonaws.kendra#DocumentRelevanceOverrideConfigurationList", "traits": { - "smithy.api#documentation": "

Overrides relevance tuning configurations of fields or attributes set at the index\n level.

\n

If you use this API to override the relevance tuning configured at the index level, but\n there is no relevance tuning configured at the index level, then Amazon Kendra does\n not apply any relevance tuning.

\n

If there is relevance tuning configured at the index level, but you do not use this API\n to override any relevance tuning in the index, then Amazon Kendra uses the relevance\n tuning that is configured at the index level.

\n

If there is relevance tuning configured for fields at the index level, but you use this\n API to override only some of these fields, then for the fields you did not override, the\n importance is set to 1.

" + "smithy.api#documentation": "

Overrides relevance tuning configurations of fields/attributes set at the index level.

\n

If you use this API to override the relevance tuning configured at the index level, but there \n is no relevance tuning configured at the index level, then Amazon Kendra does not apply any \n relevance tuning.

\n

If there is relevance tuning configured for fields at the index level, and you use this API to \n override only some of these fields, then for the fields you did not override, the importance is \n set to 1.

" } }, "PageNumber": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

Query results are returned in pages the size of the PageSize parameter. By\n default, Amazon Kendra returns the first page of results. Use this parameter to get\n result pages after the first one.

" + "smithy.api#documentation": "

Query results are returned in pages the size of the PageSize parameter. \n By default, Amazon Kendra returns the first page of results. Use this parameter to \n get result pages after the first one.

" } }, "PageSize": { @@ -11745,7 +11757,7 @@ "SortingConfiguration": { "target": "com.amazonaws.kendra#SortingConfiguration", "traits": { - "smithy.api#documentation": "

Provides information that determines how the results of the query are sorted. You can\n set the field that Amazon Kendra should sort the results on, and specify whether the\n results should be sorted in ascending or descending order. In the case of ties in sorting\n the results, the results are sorted by relevance.

\n

If you don't provide sorting configuration, the results are sorted by the relevance that\n Amazon Kendra determines for the result.

" + "smithy.api#documentation": "

Provides information that determines how the results of the query are sorted. You can\n set the field that Amazon Kendra should sort the results on, and specify whether the\n results should be sorted in ascending or descending order. In the case of ties in sorting\n the results, the results are sorted by relevance.

\n

If you don't provide sorting configuration, the results are sorted by the relevance that \n Amazon Kendra determines for the result.

" } }, "UserContext": { @@ -11777,7 +11789,7 @@ "QueryId": { "target": "com.amazonaws.kendra#QueryId", "traits": { - "smithy.api#documentation": "

The identifier for the search. You use QueryId to identify the\n search when using the feedback API.

" + "smithy.api#documentation": "

The identifier for the search. You also use QueryId to identify the\n search when using the SubmitFeedback API.

" } }, "ResultItems": { @@ -11789,13 +11801,13 @@ "FacetResults": { "target": "com.amazonaws.kendra#FacetResultList", "traits": { - "smithy.api#documentation": "

Contains the facet results. A FacetResult contains the counts for each\n attribute key that was specified in the Facets input parameter.

" + "smithy.api#documentation": "

Contains the facet results. A FacetResult contains the counts for each\n field/attribute key that was specified in the Facets input parameter.

" } }, "TotalNumberOfResults": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The total number of items found by the search; however, you can only retrieve up to 100\n items. For example, if the search found 192 items, you can only retrieve the first 100 of\n the items.

" + "smithy.api#documentation": "

The total number of items found by the search. However, you can only retrieve up to \n 100 items. For example, if the search found 192 items, you can only retrieve the first \n 100 of the items.

" } }, "Warnings": { @@ -11816,6 +11828,9 @@ "smithy.api#documentation": "

The list of featured result items. Featured results are displayed at \n the top of the search results page, placed above all other results for \n certain queries. If there's an exact match of a query, then certain \n documents are featured in the search results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kendra#QueryResultFormat": { @@ -11859,7 +11874,7 @@ "AdditionalAttributes": { "target": "com.amazonaws.kendra#AdditionalResultAttributeList", "traits": { - "smithy.api#documentation": "

One or more additional attributes associated with the query result.

" + "smithy.api#documentation": "

One or more additional fields/attributes associated with the query result.

" } }, "DocumentId": { @@ -11889,19 +11904,19 @@ "DocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeList", "traits": { - "smithy.api#documentation": "

An array of document attributes assigned to a document in the search results. For\n example, the document author (_author) or the source URI\n (_source_uri) of the document.

" + "smithy.api#documentation": "

An array of document fields/attributes assigned to a document in the search results. \n For example, the document author (_author) or the source URI \n (_source_uri) of the document.

" } }, "ScoreAttributes": { "target": "com.amazonaws.kendra#ScoreAttributes", "traits": { - "smithy.api#documentation": "

Indicates the confidence that Amazon Kendra has that a result matches the query\n that you provided. Each result is placed into a bin that indicates the confidence,\n VERY_HIGH, HIGH, MEDIUM and LOW. You\n can use the score to determine if a response meets the confidence needed for your\n application.

\n

The field is only set to LOW when the Type field is set to\n DOCUMENT and Amazon Kendra is not confident that the result matches\n the query.

" + "smithy.api#documentation": "

Indicates the confidence level of Amazon Kendra providing a relevant result for \n the query. Each result is placed into a bin that indicates the confidence,\n VERY_HIGH, HIGH, MEDIUM and LOW. \n You can use the score to determine if a response meets the confidence needed for your\n application.

\n

The field is only set to LOW when the Type field is set to\n DOCUMENT and Amazon Kendra is not confident that the result is \n relevant to the query.

" } }, "FeedbackToken": { "target": "com.amazonaws.kendra#FeedbackToken", "traits": { - "smithy.api#documentation": "

A token that identifies a particular result from a particular query. Use this token to\n provide click-through feedback for the result. For more information, see Submitting feedback\n .

" + "smithy.api#documentation": "

A token that identifies a particular result from a particular query. Use this token to\n provide click-through feedback for the result. For more information, see Submitting feedback.

" } }, "TableExcerpt": { @@ -12082,13 +12097,7 @@ } }, "com.amazonaws.kendra#QueryText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } + "type": "string" }, "com.amazonaws.kendra#QueryTextList": { "type": "list", @@ -12364,6 +12373,169 @@ } } }, + "com.amazonaws.kendra#Retrieve": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#RetrieveRequest" + }, + "output": { + "target": "com.amazonaws.kendra#RetrieveResult" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves relevant passages or text excerpts given an input query.

\n

This API is similar to the Query \n API. However, by default, the Query API only \n returns excerpt passages of up to 100 token words. With the \n Retrieve API, you can retrieve longer passages of up to \n 200 token words and up to 100 semantically relevant passages. This doesn't \n include question-answer or FAQ type responses from your index. The passages \n are text excerpts that can be semantically extracted from multiple documents \n and multiple parts of the same document. If in extreme cases your documents \n produce no relevant passages using the Retrieve API, you can \n alternatively use the Query API.

\n

You can also do the following:

\n \n

You can also include certain fields in the response that might provide useful\n additional information.

" + } + }, + "com.amazonaws.kendra#RetrieveRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index to retrieve relevant passages for the \n search.

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

The input query text to retrieve relevant passages for the search. \n Amazon Kendra truncates queries at 30 token words, which excludes \n punctuation and stop words. Truncation still applies if you use Boolean \n or more advanced, complex queries.

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

Filters search results by document fields/attributes. You can only provide \n one attribute filter; however, the AndAllFilters, NotFilter, \n and OrAllFilters parameters contain a list of other filters.

\n

The AttributeFilter parameter means you can create a set of \n filtering rules that a document must satisfy to be included in the query results.

" + } + }, + "RequestedDocumentAttributes": { + "target": "com.amazonaws.kendra#DocumentAttributeKeyList", + "traits": { + "smithy.api#documentation": "

A list of document fields/attributes to include in the response. You can limit \n the response to include certain document fields. By default, all document \n fields are included in the response.

" + } + }, + "DocumentRelevanceOverrideConfigurations": { + "target": "com.amazonaws.kendra#DocumentRelevanceOverrideConfigurationList", + "traits": { + "smithy.api#documentation": "

Overrides relevance tuning configurations of fields/attributes set at the index \n level.

\n

If you use this API to override the relevance tuning configured at the index level, \n but there is no relevance tuning configured at the index level, then \n Amazon Kendra does not apply any relevance tuning.

\n

If there is relevance tuning configured for fields at the index level, and you use \n this API to override only some of these fields, then for the fields you did not \n override, the importance is set to 1.

" + } + }, + "PageNumber": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "

Retrieved relevant passages are returned in pages the size of the \n PageSize parameter. By default, Amazon Kendra returns the first page \n of results. Use this parameter to get result pages after the first one.

" + } + }, + "PageSize": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "

Sets the number of retrieved relevant passages that are returned in each page of \n results. The default page size is 10. The maximum number of results returned is 100. \n If you ask for more than 100 results, only 100 are returned.

" + } + }, + "UserContext": { + "target": "com.amazonaws.kendra#UserContext", + "traits": { + "smithy.api#documentation": "

The user context token or user and group information.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kendra#RetrieveResult": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.kendra#QueryId", + "traits": { + "smithy.api#documentation": "

The identifier of query used for the search. You also use QueryId to \n identify the search when using the Submitfeedback API.

" + } + }, + "ResultItems": { + "target": "com.amazonaws.kendra#RetrieveResultItemList", + "traits": { + "smithy.api#documentation": "

The results of the retrieved relevant passages for the search.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.kendra#RetrieveResultItem": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#ResultId", + "traits": { + "smithy.api#documentation": "

The identifier of the relevant passage result.

" + } + }, + "DocumentId": { + "target": "com.amazonaws.kendra#DocumentId", + "traits": { + "smithy.api#documentation": "

The identifier of the document.

" + } + }, + "DocumentTitle": { + "target": "com.amazonaws.kendra#DocumentTitle", + "traits": { + "smithy.api#documentation": "

The title of the document.

" + } + }, + "Content": { + "target": "com.amazonaws.kendra#Content", + "traits": { + "smithy.api#documentation": "

The contents of the relevant passage.

" + } + }, + "DocumentURI": { + "target": "com.amazonaws.kendra#Url", + "traits": { + "smithy.api#documentation": "

The URI of the original location of the document.

" + } + }, + "DocumentAttributes": { + "target": "com.amazonaws.kendra#DocumentAttributeList", + "traits": { + "smithy.api#documentation": "

An array of document fields/attributes assigned to a document in the \n search results. For example, the document author (_author) \n or the source URI (_source_uri) of the document.

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

A single retrieved relevant passage result.

" + } + }, + "com.amazonaws.kendra#RetrieveResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#RetrieveResultItem" + } + }, "com.amazonaws.kendra#RoleArn": { "type": "string", "traits": { @@ -12933,12 +13105,12 @@ "ScoreConfidence": { "target": "com.amazonaws.kendra#ScoreConfidence", "traits": { - "smithy.api#documentation": "

A relative ranking for how well the response matches the query.

" + "smithy.api#documentation": "

A relative ranking for how relevant the response is to the query.

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

Provides a relative ranking that indicates how confident Amazon Kendra is that the\n response matches the query.

" + "smithy.api#documentation": "

Provides a relative ranking that indicates how confident Amazon Kendra is that the\n response is relevant to the query.

" } }, "com.amazonaws.kendra#ScoreConfidence": { @@ -13060,7 +13232,7 @@ "WebCrawlerMode": { "target": "com.amazonaws.kendra#WebCrawlerMode", "traits": { - "smithy.api#documentation": "

You can choose one of the following modes:

\n \n

The default mode is set to HOST_ONLY.

" + "smithy.api#documentation": "

You can choose one of the following modes:

\n \n

The default mode is set to HOST_ONLY.

" } } }, @@ -13198,13 +13370,13 @@ "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to include certain attachments of knowledge\n articles in your ServiceNow. Item that match the patterns are included in the index.\n Items that don't match the patterns are excluded from the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.

\n

The regex is applied to the field specified in the\n PatternTargetField.

" + "smithy.api#documentation": "

A list of regular expression patterns applied to include knowledge article\n attachments. Attachments that match the patterns are included in the index. Items that\n don't match the patterns are excluded from the index. If an item matches both an\n inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.

" } }, "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to exclude certain attachments of knowledge\n articles in your ServiceNow. Item that match the patterns are excluded from the index.\n Items that don't match the patterns are included in the index. If an item matches both\n an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item\n isn't included in the index.

\n

The regex is applied to the field specified in the\n PatternTargetField.

" + "smithy.api#documentation": "

A list of regular expression patterns applied to exclude certain knowledge article\n attachments. Attachments that match the patterns are excluded from the index. Items that\n don't match the patterns are included in the index. If an item matches both an inclusion\n and exclusion pattern, the exclusion pattern takes precedence and the item isn't\n included in the index.

" } }, "DocumentDataFieldName": { @@ -15785,7 +15957,7 @@ "CrawlDepth": { "target": "com.amazonaws.kendra#CrawlDepth", "traits": { - "smithy.api#documentation": "

Specifies the number of levels in a website that you want to crawl.

\n

The first level begins from the website seed or starting point URL. For example, if a\n website has three levels—index level (the seed in this example), sections level, and\n subsections level—and you are only interested in crawling information up to the\n sections level (levels 0-1), you can set your depth to 1.

\n

The default crawl depth is set to 2.

" + "smithy.api#documentation": "

The 'depth' or number of levels from the seed level to crawl. For example, the seed \n URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

" } }, "MaxLinksPerPage": { diff --git a/codegen/sdk/aws-models/kinesis-analytics-v2.json b/codegen/sdk/aws-models/kinesis-analytics-v2.json index b3f9a59bdb4..8af138d065b 100644 --- a/codegen/sdk/aws-models/kinesis-analytics-v2.json +++ b/codegen/sdk/aws-models/kinesis-analytics-v2.json @@ -90,6 +90,9 @@ "smithy.api#documentation": "

A value you use to implement strong concurrency for application updates. You must\n provide the CurrentApplicationVersionId or the ConditionalToken. You\n get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the\n ConditionalToken parameter instead of\n CurrentApplicationVersionId.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationCloudWatchLoggingOptionResponse": { @@ -113,6 +116,9 @@ "smithy.api#documentation": "

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInput": { @@ -207,6 +213,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputProcessingConfigurationResponse": { @@ -236,6 +245,9 @@ "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputRequest": { @@ -262,6 +274,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputResponse": { @@ -285,6 +300,9 @@ "smithy.api#documentation": "

Describes the application input configuration. \n \n \n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationOutput": { @@ -340,6 +358,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationOutputResponse": { @@ -363,6 +384,9 @@ "smithy.api#documentation": "

Describes the application output configuration.\n For more information, \n see Configuring Application Output. \n \n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationReferenceDataSource": { @@ -418,6 +442,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationReferenceDataSourceResponse": { @@ -441,6 +468,9 @@ "smithy.api#documentation": "

Describes reference data sources configured for the application. \n \n \n \n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationVpcConfiguration": { @@ -501,6 +531,9 @@ "smithy.api#documentation": "

A value you use to implement strong concurrency for application updates. You must\n provide the ApplicationVersionID or the ConditionalToken. You get\n the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the\n ConditionalToken parameter instead of\n CurrentApplicationVersionId.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationVpcConfigurationResponse": { @@ -524,6 +557,9 @@ "smithy.api#documentation": "

The parameters of the new VPC configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfiguration": { @@ -1761,6 +1797,9 @@ "smithy.api#documentation": "

The duration in seconds for which the returned URL will be valid.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationPresignedUrlResponse": { @@ -1772,6 +1811,9 @@ "smithy.api#documentation": "

The URL of the extension.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationRequest": { @@ -1828,6 +1870,9 @@ "smithy.api#documentation": "

Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the \n INTERACTIVE mode.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationResponse": { @@ -1840,6 +1885,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationSnapshot": { @@ -1894,11 +1942,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationSnapshotResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#CustomArtifactConfiguration": { "type": "structure", @@ -2074,6 +2128,9 @@ "smithy.api#documentation": "

A value you use to implement strong concurrency for application updates. You must provide\n the CurrentApplicationVersionId or the ConditionalToken. You get the\n application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of\n CurrentApplicationVersionId.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationCloudWatchLoggingOptionResponse": { @@ -2097,6 +2154,9 @@ "smithy.api#documentation": "

The descriptions of the remaining CloudWatch logging options for the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationInputProcessingConfiguration": { @@ -2152,6 +2212,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationInputProcessingConfigurationResponse": { @@ -2169,6 +2232,9 @@ "smithy.api#documentation": "

The current application version ID.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationOutput": { @@ -2224,6 +2290,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationOutputResponse": { @@ -2241,6 +2310,9 @@ "smithy.api#documentation": "

The current application version ID.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationReferenceDataSource": { @@ -2296,6 +2368,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationReferenceDataSourceResponse": { @@ -2313,6 +2388,9 @@ "smithy.api#documentation": "

The updated version ID of the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationRequest": { @@ -2332,11 +2410,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationSnapshot": { "type": "operation", @@ -2394,11 +2478,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationSnapshotResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationVpcConfiguration": { "type": "operation", @@ -2458,6 +2548,9 @@ "smithy.api#documentation": "

A value you use to implement strong concurrency for application updates. You must provide\n the CurrentApplicationVersionId or the ConditionalToken. You get the\n application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of\n CurrentApplicationVersionId.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationVpcConfigurationResponse": { @@ -2475,6 +2568,9 @@ "smithy.api#documentation": "

The updated version ID of the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DeployAsApplicationConfiguration": { @@ -2560,6 +2656,9 @@ "smithy.api#documentation": "

Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationResponse": { @@ -2572,6 +2671,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationSnapshot": { @@ -2614,6 +2716,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationSnapshotResponse": { @@ -2626,6 +2731,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationVersion": { @@ -2668,6 +2776,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationVersionResponse": { @@ -2676,6 +2787,9 @@ "ApplicationVersionDetail": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationDetail" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#DestinationSchema": { @@ -2759,6 +2873,9 @@ "smithy.api#documentation": "

The InputProcessingConfiguration to use to preprocess the records \n before discovering the schema of the records.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#DiscoverInputSchemaResponse": { @@ -2788,6 +2905,9 @@ "smithy.api#documentation": "

The raw stream data that was sampled to infer the schema.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#EnvironmentProperties": { @@ -4837,6 +4957,9 @@ "smithy.api#documentation": "

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more \n output available. Set it to the value of the previous call's NextToken response to indicate where the output should \n continue from.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationSnapshotsResponse": { @@ -4854,6 +4977,9 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationVersions": { @@ -4910,6 +5036,9 @@ "smithy.api#documentation": "

If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationVersionsResponse": { @@ -4927,6 +5056,9 @@ "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no additional results. \n To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#ListApplications": { @@ -4970,6 +5102,9 @@ "smithy.api#documentation": "

If a previous command returned a pagination token, \n pass it into this value to retrieve the next set of results.\n For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationsResponse": { @@ -4988,6 +5123,9 @@ "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no additional results.\n Pass this token into a subsequent command to retrieve the next set of items\n For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#ListSnapshotsInputLimit": { @@ -5032,6 +5170,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#ListTagsForResourceResponse": { @@ -5043,6 +5184,9 @@ "smithy.api#documentation": "

The key-value tags assigned to the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#LogLevel": { @@ -6026,6 +6170,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#RollbackApplicationResponse": { @@ -6037,6 +6184,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#RunConfiguration": { @@ -6152,6 +6302,12 @@ "traits": { "smithy.api#enumValue": "FLINK-1_15" } + }, + "ZEPPELIN_FLINK_3_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZEPPELIN-FLINK-3_0" + } } } }, @@ -6685,11 +6841,17 @@ "smithy.api#documentation": "

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#StartApplicationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#StopApplication": { "type": "operation", @@ -6739,11 +6901,17 @@ "smithy.api#documentation": "

Set to true to force the application to stop. If you set Force\n to true, Kinesis Data Analytics stops the application without taking a snapshot. \n

\n \n

Force-stopping your application may lead to data loss or duplication.\n To prevent data loss or duplicate processing of data during application restarts, \n we recommend you to take frequent snapshots of your application.

\n \n

You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

\n

The application must be in the\n STARTING, UPDATING, STOPPING, AUTOSCALING, or\n RUNNING status.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#StopApplicationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#SubnetId": { "type": "string" @@ -6848,11 +7016,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#TagValue": { "type": "string", @@ -6981,11 +7155,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisanalyticsv2#UpdateApplication": { "type": "operation", @@ -7071,6 +7251,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#UpdateApplicationMaintenanceConfigurationResponse": { @@ -7088,6 +7271,9 @@ "smithy.api#documentation": "

The application maintenance configuration description after the update.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#UpdateApplicationRequest": { @@ -7136,6 +7322,9 @@ "smithy.api#documentation": "

A value you use to implement strong concurrency for application updates. You must\n provide the CurrentApplicationVersionId or the ConditionalToken. You\n get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the\n ConditionalToken parameter instead of\n CurrentApplicationVersionId.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisanalyticsv2#UpdateApplicationResponse": { @@ -7148,6 +7337,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisanalyticsv2#UrlType": { diff --git a/codegen/sdk/aws-models/kinesis-video.json b/codegen/sdk/aws-models/kinesis-video.json index 1ec6caae408..b4f82b6a02d 100644 --- a/codegen/sdk/aws-models/kinesis-video.json +++ b/codegen/sdk/aws-models/kinesis-video.json @@ -370,6 +370,9 @@ "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to associate with this channel.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#CreateSignalingChannelOutput": { @@ -381,6 +384,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created channel.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#CreateStream": { @@ -448,7 +454,7 @@ "KmsKeyId": { "target": "com.amazonaws.kinesisvideo#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" + "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (Amazon Web Services/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" } }, "DataRetentionInHours": { @@ -463,6 +469,9 @@ "smithy.api#documentation": "

A list of tags to associate with the specified stream. Each tag is a key-value pair\n (the value is optional).

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#CreateStreamOutput": { @@ -474,6 +483,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DataEndpoint": { @@ -498,6 +510,67 @@ "com.amazonaws.kinesisvideo#DeleteAfterUpload": { "type": "boolean" }, + "com.amazonaws.kinesisvideo#DeleteEdgeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DeleteEdgeConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DeleteEdgeConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesisvideo#StreamEdgeConfigurationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

\n

When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.

\n

When the deletion process has completed successfully, the edge configuration is no longer accessible.

", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteEdgeConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#DeleteEdgeConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to delete the edge configuration. Specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisvideo#DeleteEdgeConfigurationOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kinesisvideo#DeleteSignalingChannel": { "type": "operation", "input": { @@ -551,11 +624,17 @@ "smithy.api#documentation": "

The current version of the signaling channel that you want to delete. You can obtain\n the current version by invoking the DescribeSignalingChannel or\n ListSignalingChannels API operations.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DeleteSignalingChannelOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#DeleteStream": { "type": "operation", @@ -610,11 +689,17 @@ "smithy.api#documentation": "

Optional: The version of the stream that you want to delete.

\n

Specify the version as a safeguard to ensure that your are deleting the correct\n stream. To get the stream version, use the DescribeStream API.

\n

If not specified, only the CreationTime is checked before deleting the\n stream.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DeleteStreamOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#DeletionConfig": { "type": "structure", @@ -634,7 +719,7 @@ "DeleteAfterUpload": { "target": "com.amazonaws.kinesisvideo#DeleteAfterUpload", "traits": { - "smithy.api#documentation": "

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to \n the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are \n set to true, such as when the limit for the EdgeRetentionInHours, or the\n MaxLocalMediaSizeInMB, has been reached. \n

\n

Since the default value is set to true, configure the uploader schedule such \n that the media files are not being deleted before they are initially uploaded to AWS cloud.

" + "smithy.api#documentation": "

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to \n the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are \n set to true, such as when the limit for the EdgeRetentionInHours, or the\n MaxLocalMediaSizeInMB, has been reached. \n

\n

Since the default value is set to true, configure the uploader schedule such \n that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.

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

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. \n Use this API to get the status of the configuration if the configuration is in sync with the \n Edge Agent.

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

Describes a stream’s edge configuration that was set using the\n StartEdgeConfigurationUpdate API and the latest status of the edge\n agent's recorder and uploader jobs. Use this API to get the status of the configuration\n to determine if the configuration is in sync with the Edge Agent. Use this API to\n evaluate the health of the Edge Agent.

", "smithy.api#http": { "method": "POST", "uri": "/describeEdgeConfiguration", @@ -691,6 +776,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationOutput": { @@ -737,7 +825,16 @@ "traits": { "smithy.api#documentation": "

A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.

" } + }, + "EdgeAgentStatus": { + "target": "com.amazonaws.kinesisvideo#EdgeAgentStatus", + "traits": { + "smithy.api#documentation": "

An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration": { @@ -786,6 +883,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeImageGenerationConfigurationOutput": { @@ -797,6 +897,9 @@ "smithy.api#documentation": "

The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeMappedResourceConfiguration": { @@ -822,7 +925,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

\n

Returns the most current information about the stream. The streamName\n or streamARN should be provided in the input.

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

Returns the most current information about the stream. The streamName\n or streamARN should be provided in the input.

", "smithy.api#http": { "method": "POST", "uri": "/describeMappedResourceConfiguration", @@ -863,6 +966,9 @@ "smithy.api#documentation": "

The token to provide in your next request, to get another batch of results.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeMappedResourceConfigurationOutput": { @@ -880,6 +986,9 @@ "smithy.api#documentation": "

The token that was used in the NextTokenrequest to fetch the next set of results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeMediaStorageConfiguration": { @@ -928,6 +1037,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeMediaStorageConfigurationOutput": { @@ -939,6 +1051,9 @@ "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeNotificationConfiguration": { @@ -987,6 +1102,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeNotificationConfigurationOutput": { @@ -998,6 +1116,9 @@ "smithy.api#documentation": "

The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeSignalingChannel": { @@ -1046,6 +1167,9 @@ "smithy.api#documentation": "

The ARN of the signaling channel that you want to describe.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeSignalingChannelOutput": { @@ -1057,6 +1181,9 @@ "smithy.api#documentation": "

A structure that encapsulates the specified signaling channel's metadata and\n properties.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DescribeStream": { @@ -1105,6 +1232,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#DescribeStreamOutput": { @@ -1116,6 +1246,9 @@ "smithy.api#documentation": "

An object that describes the stream.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#DestinationRegion": { @@ -1170,6 +1303,26 @@ } } }, + "com.amazonaws.kinesisvideo#EdgeAgentStatus": { + "type": "structure", + "members": { + "LastRecorderStatus": { + "target": "com.amazonaws.kinesisvideo#LastRecorderStatus", + "traits": { + "smithy.api#documentation": "

The latest status of a stream’s edge recording job.

" + } + }, + "LastUploaderStatus": { + "target": "com.amazonaws.kinesisvideo#LastUploaderStatus", + "traits": { + "smithy.api#documentation": "

The latest status of a stream’s edge to cloud uploader job.

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

An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

" + } + }, "com.amazonaws.kinesisvideo#EdgeConfig": { "type": "structure", "members": { @@ -1325,6 +1478,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#GetDataEndpointOutput": { @@ -1336,6 +1492,9 @@ "smithy.api#documentation": "

The endpoint value. To read data from the stream or to write data to it, specify\n this endpoint in your application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#GetSignalingChannelEndpoint": { @@ -1388,6 +1547,9 @@ "smithy.api#documentation": "

A structure containing the endpoint configuration for the SINGLE_MASTER\n channel type.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#GetSignalingChannelEndpointOutput": { @@ -1399,6 +1561,9 @@ "smithy.api#documentation": "

A list of endpoints for the specified signaling channel.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#HeightPixels": { @@ -1494,7 +1659,7 @@ "DestinationRegion": { "target": "com.amazonaws.kinesisvideo#DestinationRegion", "traits": { - "smithy.api#documentation": "

The AWS Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

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

The Amazon Web Services Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

", "smithy.api#required": {} } } @@ -1559,6 +1724,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kinesisvideo#JobStatusDetails": { + "type": "string" + }, "com.amazonaws.kinesisvideo#KinesisVideo_20170930": { "type": "service", "version": "2017-09-30", @@ -1569,6 +1737,9 @@ { "target": "com.amazonaws.kinesisvideo#CreateStream" }, + { + "target": "com.amazonaws.kinesisvideo#DeleteEdgeConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#DeleteSignalingChannel" }, @@ -1602,6 +1773,9 @@ { "target": "com.amazonaws.kinesisvideo#GetSignalingChannelEndpoint" }, + { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurations" + }, { "target": "com.amazonaws.kinesisvideo#ListSignalingChannels" }, @@ -2536,6 +2710,213 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.kinesisvideo#LastRecorderStatus": { + "type": "structure", + "members": { + "JobStatusDetails": { + "target": "com.amazonaws.kinesisvideo#JobStatusDetails", + "traits": { + "smithy.api#documentation": "

A description of a recorder job’s latest status.

" + } + }, + "LastCollectedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the recorder job was last executed and media stored to local disk.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the recorder status was last updated.

" + } + }, + "RecorderStatus": { + "target": "com.amazonaws.kinesisvideo#RecorderStatus", + "traits": { + "smithy.api#documentation": "

The status of the latest recorder job.

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

The latest status of a stream's edge recording job.

" + } + }, + "com.amazonaws.kinesisvideo#LastUploaderStatus": { + "type": "structure", + "members": { + "JobStatusDetails": { + "target": "com.amazonaws.kinesisvideo#JobStatusDetails", + "traits": { + "smithy.api#documentation": "

A description of an uploader job’s latest status.

" + } + }, + "LastCollectedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the uploader job was last executed and media collected to the cloud.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the uploader status was last updated.

" + } + }, + "UploaderStatus": { + "target": "com.amazonaws.kinesisvideo#UploaderStatus", + "traits": { + "smithy.api#documentation": "

The status of the latest uploader job.

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

The latest status of a stream’s edge to cloud uploader job.

" + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of edge configurations associated with the specified Edge Agent.

\n

In the request, you must specify the Edge Agent HubDeviceArn.

", + "smithy.api#http": { + "method": "POST", + "uri": "/listEdgeAgentConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EdgeConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsEdgeConfig": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the stream first created the edge config.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the stream last updated the edge config.

" + } + }, + "SyncStatus": { + "target": "com.amazonaws.kinesisvideo#SyncStatus", + "traits": { + "smithy.api#documentation": "

The current sync status of the stream's edge configuration.

" + } + }, + "FailedStatusDetails": { + "target": "com.amazonaws.kinesisvideo#FailedStatusDetails", + "traits": { + "smithy.api#documentation": "

A description of the generated failure status.

" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig" + } + }, + "traits": { + "smithy.api#documentation": "

A description of a single stream's edge configuration.

" + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsEdgeConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsEdgeConfig" + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsInput": { + "type": "structure", + "members": { + "HubDeviceArn": { + "target": "com.amazonaws.kinesisvideo#HubDeviceArn", + "traits": { + "smithy.api#documentation": "

The \"Internet of Things (IoT) Thing\" Arn of the edge agent.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsInputLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of edge configurations to return in the response. The default is 5.

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

If you specify this parameter, when the result of a ListEdgeAgentConfigurations operation is truncated, the call returns the NextToken in the response. To get another batch of edge configurations, provide this token in your next request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsInputLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsOutput": { + "type": "structure", + "members": { + "EdgeConfigs": { + "target": "com.amazonaws.kinesisvideo#ListEdgeAgentConfigurationsEdgeConfigList", + "traits": { + "smithy.api#documentation": "

A description of a single stream's edge configuration.

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

If the response is truncated, the call returns this element with a given token. To get the next batch of edge configurations, use this token in your next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kinesisvideo#ListOfProtocols": { "type": "list", "member": { @@ -2603,6 +2984,9 @@ "smithy.api#documentation": "

Optional: Returns only the channels that satisfy a specific condition.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#ListSignalingChannelsOutput": { @@ -2620,6 +3004,9 @@ "smithy.api#documentation": "

If the response is truncated, the call returns this element with a token. To get the\n next batch of streams, use this token in your next request.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#ListStreams": { @@ -2674,6 +3061,9 @@ "smithy.api#documentation": "

Optional: Returns only streams that satisfy a specific condition. Currently, you\n can specify only the prefix of a stream name as a condition.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#ListStreamsInputLimit": { @@ -2700,6 +3090,9 @@ "smithy.api#documentation": "

If the response is truncated, the call returns this element with a token. To get\n the next batch of streams, use this token in your next request.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#ListTagsForResource": { @@ -2749,6 +3142,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#ListTagsForResourceOutput": { @@ -2766,6 +3162,9 @@ "smithy.api#documentation": "

A map of tag keys and values associated with the specified signaling channel.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#ListTagsForStream": { @@ -2823,6 +3222,9 @@ "smithy.api#documentation": "

The name of the stream that you want to list tags for.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#ListTagsForStreamOutput": { @@ -2840,6 +3242,9 @@ "smithy.api#documentation": "

A map of tag keys and values associated with the specified stream.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#LocalSizeConfig": { @@ -2918,7 +3323,7 @@ "MediaUriSecretArn": { "target": "com.amazonaws.kinesisvideo#MediaUriSecretArn", "traits": { - "smithy.api#documentation": "

The AWS Secrets Manager ARN for the username and password of the camera, or a local media file location.

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

The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.

", "smithy.api#required": {} } }, @@ -3113,6 +3518,29 @@ "smithy.api#documentation": "

The recorder configuration consists of the local MediaSourceConfig details that are used as \n credentials to accesss the local media files streamed on the camera.

" } }, + "com.amazonaws.kinesisvideo#RecorderStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "USER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ERROR" + } + }, + "SYSTEM_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_ERROR" + } + } + } + }, "com.amazonaws.kinesisvideo#ResourceARN": { "type": "string", "traits": { @@ -3149,7 +3577,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that describes the endpoint of the signaling channel returned by the\n GetSignalingChannelEndpoint API.

" + "smithy.api#documentation": "

An object that describes the endpoint of the signaling channel returned by the\n GetSignalingChannelEndpoint API.

\n

The media server endpoint will correspond to the WEBRTC Protocol.

" } }, "com.amazonaws.kinesisvideo#ResourceInUseException": { @@ -3221,7 +3649,7 @@ } }, "traits": { - "smithy.api#documentation": "

This API enables you to specify the duration that the camera,\n or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the \n DurationInMinutes attributes.

\n

If the ScheduleExpression is not provided,\n then the Edge Agent will always be set to recording mode.

" + "smithy.api#documentation": "

This API enables you to specify the duration that the camera,\n or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the \n DurationInMinutes attributes.

\n

If the ScheduleConfig is not provided in the RecorderConfig,\n then the Edge Agent will always be set to recording mode.

\n

If the ScheduleConfig is not provided in the UploaderConfig,\n then the Edge Agent will upload at regular intervals (every 1 hour).

" } }, "com.amazonaws.kinesisvideo#ScheduleExpression": { @@ -3327,6 +3755,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateOutput": { @@ -3374,6 +3805,9 @@ "smithy.api#documentation": "

A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideo#Status": { @@ -3571,6 +4005,12 @@ "traits": { "smithy.api#enumValue": "DELETE_FAILED" } + }, + "DELETING_ACKNOWLEDGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING_ACKNOWLEDGED" + } } } }, @@ -3693,11 +4133,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#TagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#TagStream": { "type": "operation", @@ -3758,11 +4204,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#TagStreamOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#TagValue": { "type": "string", @@ -3841,11 +4293,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UntagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UntagStream": { "type": "operation", @@ -3903,11 +4361,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UntagStreamOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateDataRetention": { "type": "operation", @@ -3982,6 +4446,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateDataRetentionOperation": { @@ -4003,7 +4470,10 @@ }, "com.amazonaws.kinesisvideo#UpdateDataRetentionOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateImageGenerationConfiguration": { "type": "operation", @@ -4063,11 +4533,17 @@ "smithy.api#documentation": "

The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateImageGenerationConfigurationOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateMediaStorageConfiguration": { "type": "operation", @@ -4123,11 +4599,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateMediaStorageConfigurationOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration": { "type": "operation", @@ -4187,11 +4669,17 @@ "smithy.api#documentation": "

The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateNotificationConfigurationOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateSignalingChannel": { "type": "operation", @@ -4253,11 +4741,17 @@ "smithy.api#documentation": "

The structure containing the configuration for the SINGLE_MASTER type of\n the signaling channel that you want to update.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateSignalingChannelOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UpdateStream": { "type": "operation", @@ -4330,11 +4824,17 @@ "smithy.api#documentation": "

The stream's media type. Use MediaType to specify the type of content\n that the stream contains to the consumers of the stream. For more information about\n media types, see Media\n Types. If you choose to specify the MediaType, see Naming\n Requirements.

\n

To play video on the console, you must specify the correct video type. For example,\n if the video in the stream is H.264, specify video/h264 as the\n MediaType.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideo#UpdateStreamOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.kinesisvideo#UploaderConfig": { "type": "structure", @@ -4342,13 +4842,36 @@ "ScheduleConfig": { "target": "com.amazonaws.kinesisvideo#ScheduleConfig", "traits": { - "smithy.api#documentation": "

The configuration that consists of the ScheduleExpression and the \n DurationInMinutesdetails that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleExpression is not provided,\n then the Edge Agent will always be in recording mode.

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

The configuration that consists of the ScheduleExpression and the \n DurationInMinutes details that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig,\n then the Edge Agent will upload at regular intervals (every 1 hour).

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

The configuration that consists of the ScheduleExpression\n and the DurationInMinutesdetails, that specify the scheduling to record from a camera,\n or local media file, onto the Edge Agent. If the ScheduleExpression\n is not provided, then the Edge Agent will always be in upload mode.\n

" + "smithy.api#documentation": "

The configuration that consists of the ScheduleExpression\n and the DurationInMinutes details that specify the scheduling to record from a camera,\n or local media file, onto the Edge Agent. If the ScheduleConfig\n is not provided in the UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).\n

" + } + }, + "com.amazonaws.kinesisvideo#UploaderStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "USER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ERROR" + } + }, + "SYSTEM_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_ERROR" + } + } } }, "com.amazonaws.kinesisvideo#Version": { diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index 31447c1e408..116b438fba1 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -2567,13 +2567,13 @@ "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon\n DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams and Amazon DocumentDB.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" } }, "StartingPositionTimestamp": { "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading.

" + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" } }, "DestinationConfig": { @@ -3133,6 +3133,9 @@ { "target": "com.amazonaws.lambda#InvalidParameterValueException" }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, { "target": "com.amazonaws.lambda#ResourceInUseException" }, @@ -3197,7 +3200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted.

\n

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

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

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit\n permissions for DeleteAlias.

\n

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

", "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}", @@ -3912,13 +3915,13 @@ "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis\n streams and Amazon DocumentDB.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" } }, "StartingPositionTimestamp": { "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading.

" + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" } }, "BatchSize": { @@ -10159,7 +10162,7 @@ } }, "traits": { - "smithy.api#documentation": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a\n snapshot of the initialized execution environment when you publish a function version.

\n

SnapStart is supported with the java11 runtime. For more information, see\n Improving startup performance with Lambda\n SnapStart.

" + "smithy.api#documentation": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a\n snapshot of the initialized execution environment when you publish a function version.

" } }, "com.amazonaws.lambda#SnapStartApplyOn": { diff --git a/codegen/sdk/aws-models/macie2.json b/codegen/sdk/aws-models/macie2.json index bc91de6b403..63ec5f70d31 100644 --- a/codegen/sdk/aws-models/macie2.json +++ b/codegen/sdk/aws-models/macie2.json @@ -1413,7 +1413,7 @@ "additionalOccurrences": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).

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

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

", "smithy.api#jsonName": "additionalOccurrences" } }, @@ -1470,7 +1470,7 @@ "reason": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.

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

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.

", "smithy.api#jsonName": "reason" } } @@ -1765,7 +1765,7 @@ "managedDataIdentifierSelector": { "target": "com.amazonaws.macie2#ManagedDataIdentifierSelector", "traits": { - "smithy.api#documentation": "

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

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

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don't specify a value for this property, the job uses all managed data identifiers.

If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the job starts to run.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

", "smithy.api#jsonName": "managedDataIdentifierSelector" } }, @@ -1931,7 +1931,7 @@ "severityLevels": { "target": "com.amazonaws.macie2#SeverityLevelList", "traits": { - "smithy.api#documentation": "

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

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

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

", "smithy.api#jsonName": "severityLevels" } }, @@ -3324,14 +3324,14 @@ "managedDataIdentifierIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector). This value is null if the job's managed data identifier selection type is ALL or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.

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

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).

This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.

", "smithy.api#jsonName": "managedDataIdentifierIds" } }, "managedDataIdentifierSelector": { "target": "com.amazonaws.macie2#ManagedDataIdentifierSelector", "traits": { - "smithy.api#documentation": "

The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:

If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

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

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

If this value is null, the job uses all managed data identifiers.

If the job is a recurring job and this value is null, ALL, or EXCLUDE, each job run automatically uses new managed data identifiers that are released after the job was created or the preceding run ended. If this value is RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

", "smithy.api#jsonName": "managedDataIdentifierSelector" } }, @@ -5237,7 +5237,7 @@ "severityLevels": { "target": "com.amazonaws.macie2#SeverityLevelList", "traits": { - "smithy.api#documentation": "

Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

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

Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

", "smithy.api#jsonName": "severityLevels" } }, @@ -6212,7 +6212,7 @@ "reasons": { "target": "com.amazonaws.macie2#__listOfUnavailabilityReasonCode", "traits": { - "smithy.api#documentation": "

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

This value is null if sensitive data can be retrieved for the finding.

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

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

This value is null if sensitive data can be retrieved for the finding.

", "smithy.api#jsonName": "reasons" } } @@ -9837,6 +9837,12 @@ "traits": { "smithy.api#enumValue": "NONE" } + }, + "RECOMMENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOMMENDED" + } } }, "traits": { @@ -10703,28 +10709,28 @@ "totalItemsSkipped": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie hasn't analyzed in the bucket due to an error or issue. For example, the object is a malformed file. This value includes objects that Macie hasn't analyzed for reasons reported by other statistics in the ResourceStatistics object.

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

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.

", "smithy.api#jsonName": "totalItemsSkipped" } }, "totalItemsSkippedInvalidEncryption": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie hasn't analyzed in the bucket because the objects are encrypted with a key that Macie isn't allowed to use.

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

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys (SSE-C).

", "smithy.api#jsonName": "totalItemsSkippedInvalidEncryption" } }, "totalItemsSkippedInvalidKms": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie hasn't analyzed in the bucket because the objects are encrypted with an KMS key that was disabled or deleted.

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

The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.

", "smithy.api#jsonName": "totalItemsSkippedInvalidKms" } }, "totalItemsSkippedPermissionDenied": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie hasn't analyzed in the bucket because Macie isn't allowed to access the objects.

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

The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

", "smithy.api#jsonName": "totalItemsSkippedPermissionDenied" } } @@ -11122,7 +11128,7 @@ "key": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The full key (name) that's assigned to the object.

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

The full name (key) of the object, including the object's prefix if applicable.

", "smithy.api#jsonName": "key" } }, @@ -11136,7 +11142,7 @@ "path": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The path to the object, including the full key (name).

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

The full path to the affected object, including the name of the affected bucket and the object's name (key).

", "smithy.api#jsonName": "path" } }, @@ -12045,7 +12051,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that matches the custom data identifier's detection criteria.

" + "smithy.api#documentation": "

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that match the custom data identifier's detection criteria.

" } }, "com.amazonaws.macie2#SeverityLevelList": { @@ -12182,7 +12188,7 @@ "attributeName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

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

The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.

", "smithy.api#jsonName": "attributeName" } }, @@ -12702,7 +12708,7 @@ "message": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by the finding. Possible values are:

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

The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by the finding. Possible values are:

", "smithy.api#jsonName": "message", "smithy.api#required": {} } diff --git a/codegen/sdk/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index 02a57212440..a528477f580 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -9448,8 +9448,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -9461,8 +9461,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -9474,8 +9474,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -9487,8 +9487,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -9500,8 +9500,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -9513,8 +9513,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -9526,8 +9526,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -9539,8 +9539,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -9550,8 +9550,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -9563,8 +9563,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -9574,8 +9574,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -9587,8 +9587,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -9600,8 +9600,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -9613,8 +9613,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -9626,8 +9626,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -9639,8 +9639,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -9650,8 +9650,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -9663,8 +9663,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -9674,8 +9674,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -9687,8 +9687,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -9700,8 +9700,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -9712,8 +9712,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -9724,8 +9724,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -14483,6 +14483,10 @@ { "name": "NEXTFLOW", "value": "NEXTFLOW" + }, + { + "name": "CWL", + "value": "CWL" } ], "smithy.api#length": { diff --git a/codegen/sdk/aws-models/pinpoint.json b/codegen/sdk/aws-models/pinpoint.json index 821889650c9..38a72a2a738 100644 --- a/codegen/sdk/aws-models/pinpoint.json +++ b/codegen/sdk/aws-models/pinpoint.json @@ -12662,6 +12662,12 @@ "traits": { "smithy.api#documentation": "

The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

" } + }, + "TimezoneEstimationMethods": { + "target": "com.amazonaws.pinpoint#ListOf__TimezoneEstimationMethodsElement", + "traits": { + "smithy.api#documentation": "

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

" + } } }, "traits": { @@ -13253,6 +13259,12 @@ "target": "com.amazonaws.pinpoint#__EndpointTypesElement" } }, + "com.amazonaws.pinpoint#ListOf__TimezoneEstimationMethodsElement": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpoint#__TimezoneEstimationMethodsElement" + } + }, "com.amazonaws.pinpoint#ListOf__string": { "type": "list", "member": { @@ -21116,6 +21128,12 @@ "traits": { "smithy.api#documentation": "

The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

" } + }, + "TimezoneEstimationMethods": { + "target": "com.amazonaws.pinpoint#ListOf__TimezoneEstimationMethodsElement", + "traits": { + "smithy.api#documentation": "

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

" + } } }, "traits": { @@ -21289,6 +21307,23 @@ } } }, + "com.amazonaws.pinpoint#__TimezoneEstimationMethodsElement": { + "type": "enum", + "members": { + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE_NUMBER" + } + }, + "POSTAL_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTAL_CODE" + } + } + } + }, "com.amazonaws.pinpoint#__blob": { "type": "blob" }, diff --git a/codegen/sdk/aws-models/privatenetworks.json b/codegen/sdk/aws-models/privatenetworks.json index db876ece690..fbb6897e3f2 100644 --- a/codegen/sdk/aws-models/privatenetworks.json +++ b/codegen/sdk/aws-models/privatenetworks.json @@ -145,7 +145,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The tags on the device identifier. \n

" + "smithy.api#documentation": "

The tags on the device identifier.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

Determines the duration and renewal status of the commitment period for all pending radio\n units.

\n

If you include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, you must specify the\n following:

\n \n

For pricing, see Amazon Web Services Private 5G\n Pricing.

\n

If you do not include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, the commitment period is set to\n 60-days.

" + } } } }, @@ -248,7 +254,7 @@ "phoneNumber": { "target": "com.amazonaws.privatenetworks#AddressContent", "traits": { - "smithy.api#documentation": "

The phone number for this address.

" + "smithy.api#documentation": "

The recipient's phone number.

" } }, "postalCode": { @@ -283,6 +289,12 @@ "traits": { "smithy.api#documentation": "

The third line of the street address.

" } + }, + "emailAddress": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The recipient's email address.

" + } } }, "traits": { @@ -314,6 +326,74 @@ } } }, + "com.amazonaws.privatenetworks#CommitmentConfiguration": { + "type": "structure", + "members": { + "commitmentLength": { + "target": "com.amazonaws.privatenetworks#CommitmentLength", + "traits": { + "smithy.api#documentation": "

The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year\n period.

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

Determines whether the commitment period for a radio unit is set to automatically\n renew for an additional 1 year after your current commitment period expires.

\n

Set to True, if you want your commitment period to automatically renew.\n Set to False if you do not want your commitment to automatically renew.

\n

You can do the following:

\n \n

You cannot use the automatic-renewal option for a 60-day\n commitment.

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

Determines the duration and renewal status of the commitment period for a radio\n unit.

\n

For pricing, see Amazon Web Services Private 5G\n Pricing.

" + } + }, + "com.amazonaws.privatenetworks#CommitmentInformation": { + "type": "structure", + "members": { + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

The duration and renewal status of the commitment period for the radio unit.

", + "smithy.api#required": {} + } + }, + "startAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the commitment period started.

" + } + }, + "expiresOn": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the commitment period ends. If you do not cancel or renew the\n commitment before the expiration date, you will be billed at the 60-day-commitment\n rate.

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

Shows the duration, the date and time that the contract started and ends, and the\n renewal status of the commitment period for the radio unit.

" + } + }, + "com.amazonaws.privatenetworks#CommitmentLength": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SIXTY_DAYS", + "value": "SIXTY_DAYS" + }, + { + "name": "ONE_YEAR", + "value": "ONE_YEAR" + }, + { + "name": "THREE_YEARS", + "value": "THREE_YEARS" + } + ] + } + }, "com.amazonaws.privatenetworks#ConfigureAccessPoint": { "type": "operation", "input": { @@ -334,7 +414,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures the specified network resource. \n

\n

\n Use this action to specify the geographic\n position of the hardware. You must provide Certified Professional Installer (CPI)\n credentials in the request so that we can obtain spectrum grants. For more information,\n see Radio\n units in the Amazon Web Services Private 5G User Guide.

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

Configures the specified network resource.

\n

Use this action to specify the geographic position of the hardware. You must provide\n Certified Professional Installer (CPI) credentials in the request so that we can obtain\n spectrum grants. For more information, see Radio units in the\n Amazon Web Services Private 5G User Guide.

", "smithy.api#http": { "uri": "/v1/network-resources/configure", "method": "POST", @@ -372,7 +452,7 @@ "cpiUserId": { "target": "com.amazonaws.privatenetworks#SensitiveString", "traits": { - "smithy.api#documentation": "

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

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

The CPI user ID of the CPI user who is certifying the coordinates of the network\n resource.

", "smithy.api#length": { "min": 1, "max": 4096 @@ -448,7 +528,7 @@ "networkName": { "target": "com.amazonaws.privatenetworks#Name", "traits": { - "smithy.api#documentation": "

The name of the network. You can't change the name after you create the network.

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

The name of the network. You can't change the name after you create the\n network.

", "smithy.api#required": {} } }, @@ -467,7 +547,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The tags to apply to the network.\n

" + "smithy.api#documentation": "

The tags to apply to the network.

" } } } @@ -485,7 +565,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network tags. \n

" + "smithy.api#documentation": "

The network tags.

" } } } @@ -557,19 +637,19 @@ "availabilityZone": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

" + "smithy.api#documentation": "

The Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

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

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

" + "smithy.api#documentation": "

The ID of the Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

" } }, "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The tags to apply to the network site.\n

" + "smithy.api#documentation": "

The tags to apply to the network site.

" } } } @@ -586,7 +666,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network site tags.\n

" + "smithy.api#documentation": "

The network site tags.

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

Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see \n DeleteNetworkSite in the \n API Reference for Amazon Web Services Private 5G.

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

Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private\n 5G.

", "smithy.api#http": { "uri": "/v1/networks/{networkArn}", "method": "DELETE", @@ -798,13 +878,13 @@ "trafficGroupArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic group to which the device identifier\n belongs.

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

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which the device identifier\n appears.

" } }, "imsi": { @@ -835,7 +915,7 @@ "orderArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase the device\n identifier.

" } }, "createdAt": { @@ -1761,7 +1841,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The device identifier tags.\n

" + "smithy.api#documentation": "

The device identifier tags.

" } } } @@ -1863,7 +1943,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network resource tags.\n

" + "smithy.api#documentation": "

The network resource tags.

" } } } @@ -1881,7 +1961,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network tags.\n

" + "smithy.api#documentation": "

The network tags.

" } } } @@ -1940,7 +2020,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network site tags.\n

" + "smithy.api#documentation": "

The network site tags.

" } } } @@ -2000,7 +2080,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The order tags.\n

" + "smithy.api#documentation": "

The order tags.

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

Lists device identifiers. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, \n the status of device identifiers, or the ARN of the traffic group.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

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

Lists device identifiers. Add filters to your request to return a more specific list\n of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status\n of device identifiers, or the ARN of the traffic group.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", "smithy.api#http": { "uri": "/v1/device-identifiers/list", "method": "POST", @@ -2106,7 +2186,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilters", "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" } }, "networkArn": { @@ -2172,7 +2252,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists network resources. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or \n the status of network resources.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

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

Lists network resources. Add filters to your request to return a more specific list of\n results. Use filters to match the Amazon Resource Name (ARN) of an order or the status\n of network resources.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", "smithy.api#http": { "uri": "/v1/network-resources", "method": "POST", @@ -2193,7 +2273,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkResourceFilters", "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" } }, "networkArn": { @@ -2259,7 +2339,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists network sites. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network site.

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

Lists network sites. Add filters to your request to return a more specific list of\n results. Use filters to match the status of the network site.

", "smithy.api#http": { "uri": "/v1/network-sites/list", "method": "POST", @@ -2280,7 +2360,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkSiteFilters", "traits": { - "smithy.api#documentation": "

The filters. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network sites.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + "smithy.api#documentation": "

The filters. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network sites.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" } }, "networkArn": { @@ -2346,7 +2426,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists networks. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network.

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

Lists networks. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network.

", "smithy.api#http": { "uri": "/v1/networks/list", "method": "POST", @@ -2367,7 +2447,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkFilters", "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" } }, "startToken": { @@ -2426,7 +2506,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists orders. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or \n the status of the order.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

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

Lists orders. Add filters to your request to return a more specific list of results.\n Use filters to match the Amazon Resource Name (ARN) of the network site or the status of\n the order.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", "smithy.api#http": { "uri": "/v1/orders/list", "method": "POST", @@ -2471,7 +2551,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#OrderFilters", "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" } } } @@ -2728,7 +2808,7 @@ "networkArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which this network resource appears.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which this network resource\n appears.

" } }, "networkSiteArn": { @@ -2740,7 +2820,7 @@ "orderArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase this network\n resource.

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

Information about a request to return the network resource.

" } + }, + "commitmentInformation": { + "target": "com.amazonaws.privatenetworks#CommitmentInformation", + "traits": { + "smithy.api#documentation": "

Information about the commitment period for the radio unit. Shows the duration, the\n date and time that the contract started and ends, and the renewal status of the\n commitment period.

" + } } }, "traits": { @@ -2953,7 +3039,7 @@ "networkArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network to which the network site belongs.

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

The Amazon Resource Name (ARN) of the network to which the network site\n belongs.

", "smithy.api#required": {} } }, @@ -2978,13 +3064,13 @@ "availabilityZone": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The parent Availability Zone for the network site.\n

" + "smithy.api#documentation": "

The parent Availability Zone for the network site.

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

\n The parent Availability Zone ID for the network site.\n

" + "smithy.api#documentation": "

The parent Availability Zone ID for the network site.

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

The creation time of the order.

" } + }, + "orderedResources": { + "target": "com.amazonaws.privatenetworks#OrderedResourceDefinitions", + "traits": { + "smithy.api#documentation": "

A list of the network resources placed in the order.

" + } } }, "traits": { @@ -3170,6 +3262,43 @@ "target": "com.amazonaws.privatenetworks#Order" } }, + "com.amazonaws.privatenetworks#OrderedResourceDefinition": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", + "traits": { + "smithy.api#documentation": "

The type of network resource in the order.

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

The number of network resources in the order.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

The duration and renewal status of the commitment period for each radio unit in the\n order. Does not show details if the resource type is DEVICE_IDENTIFIER.

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

Details of the network resources in the order.

" + } + }, + "com.amazonaws.privatenetworks#OrderedResourceDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#OrderedResourceDefinition" + } + }, "com.amazonaws.privatenetworks#PaginationToken": { "type": "string" }, @@ -3288,7 +3417,7 @@ "returnReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The reason for the return. If the return request did not include a \n reason for the return, this value is null.

" + "smithy.api#documentation": "

The reason for the return. If the return request did not include a reason for the\n return, this value is null.

" } }, "replacementOrderArn": { @@ -3300,7 +3429,7 @@ "shippingLabel": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URL of the shipping label. The shipping label is available for download\n only if the status of the network resource is PENDING_RETURN.\n For more information, see Return a radio unit.

" + "smithy.api#documentation": "

The URL of the shipping label. The shipping label is available for download only if\n the status of the network resource is PENDING_RETURN. For more information,\n see Return a\n radio unit.

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

Starts an update of the specified network resource.

\n

After you submit a request to replace or return a network resource, the status\n of the network resource is CREATING_SHIPPING_LABEL. The shipping label \n is available when the status of the network resource is PENDING_RETURN. \n After the network resource is successfully returned, its status is DELETED. \n For more information, see Return a radio unit.

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

Use this action to do the following tasks:

\n \n

After you submit a request to replace or return a network resource, the status of the\n network resource changes to CREATING_SHIPPING_LABEL. The shipping label is\n available when the status of the network resource is PENDING_RETURN. After\n the network resource is successfully returned, its status changes to\n DELETED. For more information, see Return a radio unit.

", "smithy.api#http": { "uri": "/v1/network-resources/update", "method": "POST", @@ -3376,14 +3505,14 @@ "updateType": { "target": "com.amazonaws.privatenetworks#UpdateType", "traits": { - "smithy.api#documentation": "

The update type.

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

The update type.

\n ", "smithy.api#required": {} } }, "shippingAddress": { "target": "com.amazonaws.privatenetworks#Address", "traits": { - "smithy.api#documentation": "

The shipping address. If you don't provide a shipping address when replacing or\n returning a network resource, we use the address from the original order for the\n network resource.

" + "smithy.api#documentation": "

The shipping address. If you don't provide a shipping address when replacing or\n returning a network resource, we use the address from the original order for the network\n resource.

" } }, "returnReason": { @@ -3395,6 +3524,12 @@ "max": 1000 } } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

Use this action to extend and automatically renew the commitment period for the radio\n unit. You can do the following:

\n \n

For pricing, see Amazon Web Services Private 5G\n Pricing.

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

\n Adds tags to the specified resource.\n

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

Adds tags to the specified resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -3488,7 +3623,7 @@ "resourceArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource.\n

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

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3524,7 +3659,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The request was denied due to request throttling.\n

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

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -3736,7 +3871,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

\n The network site tags.\n

" + "smithy.api#documentation": "

The network site tags.

" } } } @@ -3752,6 +3887,10 @@ { "value": "RETURN", "name": "RETURN" + }, + { + "value": "COMMITMENT", + "name": "COMMITMENT" } ] } @@ -3842,4 +3981,4 @@ } } } -} +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 9d891a73e39..065ca0f0f4c 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -3593,267 +3593,267 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n " } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the character set (CharacterSet) to associate the DB cluster with.

\n

Valid for Cluster Type: Aurora DB clusters only

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

The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The identifier for this DB cluster. This parameter is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n \n

Example: my-cluster1\n

", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you don't specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n " } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

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

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The database engine to use for this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres\n

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see Database engine updates for Amazon Aurora MySQL in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

For information, see Amazon RDS for MySQL in the Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

For information about a specific engine, see the following topics:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

\n RDS for MySQL and Aurora MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n RDS for PostgreSQL and Aurora PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: 1150-65535\n

\n

Default:

\n " } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n " } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n " } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

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

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n " } }, "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

Tags to assign to the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is encrypted.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\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

When a KMS key isn't specified in KmsKeyId:

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

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\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

When a KMS key isn't specified in KmsKeyId:

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

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make\n sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for Cluster Type: Aurora DB clusters only

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n " } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n \n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

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

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for Cluster Type: Aurora DB clusters only

" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

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

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

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

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

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

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

\n

For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For more information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n \n

Default:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n " } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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: Multi-AZ DB clusters only

" + "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: Multi-AZ DB clusters only

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

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

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" } }, "ServerlessV2ScalingConfiguration": { @@ -3862,7 +3862,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" } }, "DBSystemId": { @@ -3874,13 +3874,13 @@ "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

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

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

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

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } } }, @@ -4116,46 +4116,46 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

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

The meaning of this parameter differs depending on the database engine.

\n
\n
Amazon Aurora MySQL
\n
Amazon Aurora PostgreSQL
\n
Amazon RDS Custom for Oracle
\n
Amazon RDS Custom for SQL Server
\n
RDS for MariaDB
\n
RDS for MySQL
\n
RDS for Oracle
\n
RDS for PostgreSQL
\n
RDS for SQL Server
\n
\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created.

\n

Default: postgres\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    Must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

The Oracle System ID (SID) of the created RDS Custom DB instance.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    Must contain a letter.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

Not applicable. Must be null.

\n
\n
\n

The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

The Oracle System ID (SID) of the created DB instance.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine, such as the string NULL.

    \n
    • \n
\n
\n
\n

The name of the database to create when the DB instance is created.

\n

Default: postgres\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
\n

Not applicable. Must be null.

\n
\n
" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

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

The identifier for this DB instance. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:

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

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
RDS for MariaDB
\n
RDS for MySQL
\n
RDS for Oracle
\n
RDS for PostgreSQL
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

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

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Not every database engine is available for every Amazon Web Services Region.

\n

Valid Values:

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

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

\n Amazon Aurora\n

\n

Not applicable. The name for the master user is managed by the DB cluster.

\n

\n Amazon RDS\n

\n

Constraints:

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

The name for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

\n

This setting is required for RDS DB instances.

\n

Constraints:

\n " } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB\n cluster.

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBSecurityGroups": { @@ -4167,103 +4167,103 @@ "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

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

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Constraints:

\n \n

Example: us-east-1d\n

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

A DB subnet group to associate with this DB instance.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

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

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur. \n For more information, see Amazon RDS Maintenance Window \n in the Amazon RDS User Guide.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Constraints:

\n " } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

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

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then \n Amazon RDS uses the default DB parameter group for the specified DB engine and version.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n " } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

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

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1\n

\n

Constraints:

\n " } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

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

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n " } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
Amazon RDS Custom for SQL Server
\n
RDS for MariaDB
\n
RDS for Microsoft SQL Server
\n
RDS for MySQL
\n
RDS for Oracle
\n
RDS for PostgreSQL
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

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

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

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "smithy.api#documentation": "

The license model information for this DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n " } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

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

For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.

\n

This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.

\n

\n Amazon Aurora\n

\n

Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

" + "smithy.api#documentation": "

For supported engines, the character set (CharacterSet) to associate the DB instance with.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "NcharCharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This parameter doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

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

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " } }, "Tags": { @@ -4275,73 +4275,97 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The identifier of the DB cluster that this DB instance will belong to.

\n

This setting doesn't apply to RDS Custom DB instances.

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

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

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

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

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

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" + "smithy.api#documentation": "

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

\n

This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

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

The Amazon Web Services KMS key identifier for an encrypted 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

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted 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

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

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

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

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

Specifies the fully qualified domain name of an Active Directory domain.

\n

Constraints:

\n \n

Example: mymanagedADtest.mymanagedAD.mydomain\n

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

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n \n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n \n

Example: 123.124.125.126,234.235.236.237\n

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" + "smithy.api#documentation": "

Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

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

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

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

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" } }, "Timezone": { @@ -4353,85 +4377,85 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

\n

\n RDS Custom\n

\n

Not applicable.

\n

\n MariaDB\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Microsoft SQL Server\n

\n

Possible values are agent and error.

\n

\n MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Oracle\n

\n

Possible values are alert, audit, listener, trace, and\n oemagent.

\n

\n PostgreSQL\n

\n

Possible values are postgresql and upgrade.

" + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n \n

The following values are valid for each DB engine:

\n " } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

\n Amazon Aurora\n

\n

Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

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

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

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

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valie Values:

\n \n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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 " + "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": { @@ -4443,7 +4467,7 @@ "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the CA certificate identifier to use for the DB instance’s server certificate.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" } } }, @@ -4712,6 +4736,30 @@ "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom.

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

Specifies the fully qualified domain name of an Active Directory domain.

\n

Constraints:

\n \n

Example: mymanagedADtest.mymanagedAD.mydomain\n

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

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n \n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n \n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { @@ -5653,13 +5701,13 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

" + "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" } }, "CharacterSetName": { @@ -5671,31 +5719,31 @@ "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" + "smithy.api#documentation": "

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

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

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + "smithy.api#documentation": "

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

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

Specifies the name of the DB cluster parameter group for the DB cluster.

" + "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

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

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

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

Specifies the current state of this DB cluster.

" + "smithy.api#documentation": "

The current state of this DB cluster.

" } }, "AutomaticRestartTime": { @@ -5707,7 +5755,7 @@ "PercentProgress": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" + "smithy.api#documentation": "

The progress of the operation as a percentage.

" } }, "EarliestRestorableTime": { @@ -5719,7 +5767,7 @@ "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the DB cluster.

" + "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" } }, "ReaderEndpoint": { @@ -5731,67 +5779,67 @@ "CustomEndpoints": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

Identifies all custom endpoints associated with the cluster.

" + "smithy.api#documentation": "

The custom endpoints associated with the DB cluster.

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

" + "smithy.api#documentation": "

Indicates whether the DB cluster has instances in multiple Availability Zones.

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

The name of the database engine to be used for this DB cluster.

" + "smithy.api#documentation": "

The database engine used for this DB cluster.

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

Indicates the database engine version.

" + "smithy.api#documentation": "

The version of the database engine.

" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" + "smithy.api#documentation": "

The latest time to which a database can be restored with point-in-time restore.

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + "smithy.api#documentation": "

The port that the database engine is listening on.

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

Contains the master username for the DB cluster.

" + "smithy.api#documentation": "

The master username for the DB cluster.

" } }, "DBClusterOptionGroupMemberships": { "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", "traits": { - "smithy.api#documentation": "

Provides the list of option group memberships for this DB cluster.

" + "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

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

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

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

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.

" + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB cluster is a read\n replica.

" } }, "ReadReplicaIdentifiers": { @@ -5803,26 +5851,26 @@ "DBClusterMembers": { "target": "com.amazonaws.rds#DBClusterMemberList", "traits": { - "smithy.api#documentation": "

Provides the list of instances that make up the DB cluster.

" + "smithy.api#documentation": "

The list of DB instances that make up the DB cluster.

" } }, "VpcSecurityGroups": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the DB cluster belongs to.

" + "smithy.api#documentation": "

The list of VPC security groups that the DB cluster belongs to.

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + "smithy.api#documentation": "

The ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" + "smithy.api#documentation": "

Indicates whether the DB cluster is encrypted.

" } }, "KmsKeyId": { @@ -5846,25 +5894,25 @@ "AssociatedRoles": { "target": "com.amazonaws.rds#DBClusterRoles", "traits": { - "smithy.api#documentation": "

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" + "smithy.api#documentation": "

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

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

Identifies the clone group to which the DB cluster is associated.

" + "smithy.api#documentation": "

The ID of the clone group with which the DB cluster is associated.

" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" } }, "EarliestBacktrackTime": { @@ -5876,7 +5924,7 @@ "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" + "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" } }, "BacktrackConsumedChangeRecords": { @@ -5894,7 +5942,7 @@ "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" } }, "EngineMode": { @@ -5909,13 +5957,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" + "smithy.api#documentation": "

Indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" } }, "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" } }, "ActivityStreamMode": { @@ -5945,13 +5993,13 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

" + "smithy.api#documentation": "

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

" } }, "CrossAccountClone": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" + "smithy.api#documentation": "

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" } }, "DomainMemberships": { @@ -5966,19 +6014,19 @@ "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" + "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in an Aurora global database.

" } }, "GlobalWriteForwardingRequested": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" + "smithy.api#documentation": "

Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" } }, "PendingModifiedValues": { "target": "com.amazonaws.rds#ClusterPendingModifiedValues", "traits": { - "smithy.api#documentation": "

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.

" + "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" } }, "DBClusterInstanceClass": { @@ -6002,14 +6050,14 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "MonitoringInterval": { @@ -6027,7 +6075,7 @@ "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

True if Performance Insights is enabled for the DB cluster, and otherwise false.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "PerformanceInsightsKMSKeyId": { @@ -6039,7 +6087,7 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

\n

Valid Values:

\n \n

Default: 7 days

" } }, "ServerlessV2ScalingConfiguration": { @@ -6048,7 +6096,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" } }, "DBSystemId": { @@ -6060,7 +6108,7 @@ "MasterUserSecret": { "target": "com.amazonaws.rds#MasterUserSecret", "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" } }, "IOOptimizedNextAllowedModificationTime": { @@ -6428,7 +6476,7 @@ "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" } }, "DBClusters": { @@ -7200,25 +7248,25 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" + "smithy.api#documentation": "

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

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

Contains the name of the compute and memory capacity class of the DB instance.

" + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

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

The name of the database engine to be used for this DB instance.

" + "smithy.api#documentation": "

The database engine used for this DB instance.

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

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" } }, "AutomaticRestartTime": { @@ -7230,45 +7278,45 @@ "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Contains the master username for the DB instance.

" + "smithy.api#documentation": "

The master username for the DB instance.

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

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

\n

Type: String

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" + "smithy.api#documentation": "

The meaning of this parameter differs depending on the database engine.

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

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

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

The connection endpoint for the DB instance.

\n \n

The endpoint might not be shown for instances with the status of creating.

\n " } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes (GiB).

" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) allocated for the DB instance.

" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Provides the date and time the DB instance was created.

" + "smithy.api#documentation": "

The date and time when the DB instance was created.

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

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" } }, "DBSecurityGroups": { @@ -7280,81 +7328,81 @@ "VpcSecurityGroups": { "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

Provides a list of VPC security group elements that the DB instance belongs to.

" + "smithy.api#documentation": "

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

" } }, "DBParameterGroups": { "target": "com.amazonaws.rds#DBParameterGroupStatusList", "traits": { - "smithy.api#documentation": "

Provides the list of DB parameter groups applied to this DB instance.

" + "smithy.api#documentation": "

The list of DB parameter groups applied to this DB instance.

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

Specifies the name of the Availability Zone the DB instance is located in.

" + "smithy.api#documentation": "

The name of the Availability Zone where the DB instance is located.

" } }, "DBSubnetGroup": { "target": "com.amazonaws.rds#DBSubnetGroup", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

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

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" } }, "PendingModifiedValues": { "target": "com.amazonaws.rds#PendingModifiedValues", "traits": { - "smithy.api#documentation": "

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + "smithy.api#documentation": "

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" } }, "LatestRestorableTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" + "smithy.api#documentation": "

The latest time to which a database in this DB instance can be restored with point-in-time restore.

" } }, "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

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

Indicates the database engine version.

" + "smithy.api#documentation": "

The version of the database engine.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

" + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

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

Contains the identifier of the source DB instance if this DB instance is a read\n replica.

" + "smithy.api#documentation": "

The identifier of the source DB instance if this DB instance is a read\n replica.

" } }, "ReadReplicaDBInstanceIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n instance.

" + "smithy.api#documentation": "

The identifiers of the read replicas associated with this DB\n instance.

" } }, "ReadReplicaDBClusterIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

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

The identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " } }, "ReplicaMode": { @@ -7366,19 +7414,19 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for this DB instance. This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value.

" + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value for the DB instance.

" } }, "OptionGroupMemberships": { "target": "com.amazonaws.rds#OptionGroupMembershipList", "traits": { - "smithy.api#documentation": "

Provides the list of option group memberships for this DB instance.

" + "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" } }, "CharacterSetName": { @@ -7403,19 +7451,19 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "StatusInfos": { "target": "com.amazonaws.rds#DBInstanceStatusInfoList", "traits": { - "smithy.api#documentation": "

The status of a read replica. If the instance isn't a read replica, this is\n blank.

" + "smithy.api#documentation": "

The status of a read replica. If the DB instance isn't a read replica, the value is\n blank.

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

Specifies the storage type associated with the DB instance.

" + "smithy.api#documentation": "

The storage type associated with the DB instance.

" } }, "TdeCredentialArn": { @@ -7428,26 +7476,26 @@ "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" + "smithy.api#documentation": "

The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

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

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

" + "smithy.api#documentation": "

Indicates whether the DB instance is encrypted.

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

If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted 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.

" + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier \n for the encrypted 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.

" } }, "DbiResourceId": { @@ -7472,7 +7520,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" + "smithy.api#documentation": "

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" } }, "MonitoringInterval": { @@ -7496,7 +7544,7 @@ "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" } }, "DBInstanceArn": { @@ -7515,13 +7563,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n

For a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

\n

For a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.

" } }, "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

True if Performance Insights is enabled for the DB instance, and otherwise false.

" + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" } }, "PerformanceInsightsKMSKeyId": { @@ -7533,13 +7581,13 @@ "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

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

The number of days to retain Performance Insights data.

\n

Valid Values:

\n \n

Default: 7 days

" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Monitoring Amazon RDS log files in the Amazon RDS User Guide.\n

" } }, "ProcessorFeatures": { @@ -7552,7 +7600,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" + "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" } }, "AssociatedRoles": { @@ -7564,7 +7612,7 @@ "ListenerEndpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { - "smithy.api#documentation": "

Specifies the listener connection endpoint for SQL Server Always On.

" + "smithy.api#documentation": "

The listener connection endpoint for SQL Server Always On.

" } }, "MaxAllocatedStorage": { @@ -7585,7 +7633,7 @@ "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { @@ -7645,13 +7693,13 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, "ActivityStreamPolicyStatus": { @@ -7663,19 +7711,19 @@ "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

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

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is valid for RDS Custom only.

" + "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is only valid for RDS Custom DB instances.

" } }, "MasterUserSecret": { "target": "com.amazonaws.rds#MasterUserSecret", "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" } }, "CertificateDetails": { @@ -7687,7 +7735,7 @@ "ReadReplicaSourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Contains the identifier of the source DB cluster if this DB instance is a read\n replica.

" + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB instance is a read\n replica.

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

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

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

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11292,13 +11340,13 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

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

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

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

A filter that specifies one or more DB clusters to describe.

\n

Supported Filters:

\n " } }, "MaxRecords": { @@ -11317,7 +11365,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" + "smithy.api#documentation": "

Specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

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

Returns information about provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

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

Describes provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11636,13 +11684,13 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

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

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

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

A filter that specifies one or more DB instances to describe.

\n

Supported Filters:

\n " } }, "MaxRecords": { @@ -13586,7 +13634,7 @@ "FQDN": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The fully qualified domain name of the Active Directory Domain.

" + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory Domain.

" } }, "IAMRoleName": { @@ -13594,6 +13642,24 @@ "traits": { "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

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

The Active Directory organizational unit for your DB instance to join.

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

" + } + }, + "DnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

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

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

" + "smithy.api#documentation": "

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

" } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -15872,208 +15938,208 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints: This identifier must match the identifier of an existing DB\n cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n ", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n \n

Example: my-cluster2\n

" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.

\n

Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.

\n

By default, this parameter is disabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.

\n

Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.

\n

By default, this parameter is disabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n " } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: 1150-65535\n

\n

Default: The same port as the original DB cluster.

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

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The new password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n " } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

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

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n " } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "BacktrackWindow": { "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

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

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n \n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

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

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.

\n

If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.

\n

If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n " } }, "DBInstanceParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Default: The existing name setting

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Valid for Cluster Type: Aurora DB clusters only

\n

Default: The existing name setting

\n

Constraints:

\n " } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

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

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnableGlobalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

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

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

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

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n \n

Default:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n " } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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: Multi-AZ DB clusters only

" + "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: Multi-AZ DB clusters only

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

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

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" } }, "ServerlessV2ScalingConfiguration": { @@ -16082,38 +16148,38 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster 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 cluster 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, 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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster 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 cluster 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, 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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "RotateMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "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 and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

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.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

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.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

The DB engine mode of the DB cluster, either provisioned or serverless.

\n \n

The DB engine mode can be modified only from serverless to provisioned.

\n \n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n \n

The DB engine mode can be modified only from serverless to provisioned.

\n \n

For more information, see \n CreateDBCluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, "AllowEngineModeChange": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether engine mode changes from serverless to provisioned \n are allowed.

\n

Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

\n

Valid for: Aurora Serverless v1 DB clusters only

" + "smithy.api#documentation": "

Specifies whether engine mode changes from serverless to provisioned \n are allowed.

\n

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

\n

Constraints:

\n " } } }, @@ -16322,310 +16388,340 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

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

The identifier of DB instance to modify. This value is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

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

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

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

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" } }, "DBSecurityGroups": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

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

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n " } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

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

A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to the following DB instances:

\n \n

Constraints:

\n " } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

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

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\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

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

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

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

" + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Uses existing setting

\n

Constraints:

\n " } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

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

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " } }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

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

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter causes a reboot\n of the DB instance. If you change this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Constraints:

\n " } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or later than the version that the source DB instance\n or cluster is running.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" + "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.

" + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n " } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \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, RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. 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.

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

The license model for the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints:

\n \n

Default: Uses existing setting

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

A value that indicates the DB instance should be associated with the specified option group.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n \n

Example: mydbinstance\n

" + "smithy.api#documentation": "

The new identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n \n

Example: mydbinstance\n

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

Specifies the storage type to be associated with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

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

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

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

Specifies the CA certificate identifier to use for the DB instance’s server certificate.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance6's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

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

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

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

Specifies the fully qualified domain name of an Active Directory domain.

\n

Constraints:

\n \n

Example: mymanagedADtest.mymanagedAD.mydomain\n

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

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n \n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n \n

Example: 123.124.125.126,234.235.236.237\n

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

\n

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" } }, "DBPortNumber": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

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

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DisableDomain": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Boolean. If present, removes the instance from the Active Directory domain.

" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom DB instances.

" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "AutomationMode": { "target": "com.amazonaws.rds#AutomationMode", "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" } }, "ResumeFullAutomationModeMinutes": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.

" + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.

\n

Default: 60\n

\n

Constraints:

\n " } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates 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, 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": "

A value that indicates 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 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 " } }, "MasterUserSecretKmsKeyId": { @@ -17028,7 +17124,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n \n

\n Oracle\n

\n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n \n

\n Oracle\n

\n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" } }, "OptionGroupName": { @@ -20819,6 +20915,30 @@ "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

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

Specifies the fully qualified domain name of an Active Directory domain.

\n

Constraints:

\n \n

Example: mymanagedADtest.mymanagedAD.mydomain\n

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

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n \n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

\n

Constraints:

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n \n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -21533,6 +21653,30 @@ "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

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

Specifies the fully qualified domain name of an Active Directory domain.

\n

Constraints:

\n \n

Example: mymanagedADtest.mymanagedAD.mydomain\n

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

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n \n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

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

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

\n

Constraints:

\n \n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n \n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -21868,7 +22012,7 @@ } }, "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { @@ -21908,7 +22052,7 @@ } }, "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { diff --git a/codegen/sdk/aws-models/s3.json b/codegen/sdk/aws-models/s3.json index f0227a4af82..a2633031e70 100644 --- a/codegen/sdk/aws-models/s3.json +++ b/codegen/sdk/aws-models/s3.json @@ -62,18 +62,6 @@ ], "traits": { "smithy.api#documentation": "

This action aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.

\n

To verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts action and ensure that\n the parts list is empty.

\n

For information about permissions required to use the multipart upload, see Multipart Upload\n and Permissions.

\n

The following operations are related to AbortMultipartUpload:

\n ", - "smithy.api#examples": [ - { - "title": "To abort a multipart upload", - "documentation": "The following example aborts a multipart upload.", - "input": { - "Bucket": "examplebucket", - "Key": "bigobject", - "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" - }, - "output": {} - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}/{Key+}?x-id=AbortMultipartUpload", @@ -101,7 +89,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -21470,7 +21458,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the newly created object. Does not return the access point\n ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The name of the bucket that contains the newly created object. Does not return the access point\n ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

" } }, "Key": { @@ -21563,7 +21551,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -21824,23 +21812,6 @@ ], "traits": { "smithy.api#documentation": "

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.

\n \n

All copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the\n Region that you want to copy the object from and the Region that you want to copy the\n object to must be enabled for your account.

\n

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. If you call the S3 API directly, make\n sure to design your application to parse the contents of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the\n embedded error and apply error handling per your configuration settings (including\n automatically retrying the request as appropriate). If the condition persists, the SDKs\n throws an exception (or, for the SDKs that don't use exceptions, they return the\n error).

\n

If the copy is successful, you receive a response with information about the copied\n object.

\n \n

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.

\n \n

The copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer\n Acceleration.

\n \n
\n
Metadata
\n
\n

When copying an object, you can preserve all metadata (the default) or specify new metadata.\n However, the access control list (ACL) is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.

\n

To specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.

\n \n

\n x-amz-website-redirect-location is unique to each object and must be\n specified in the request headers to copy the value.

\n \n
\n
x-amz-copy-source-if Headers
\n
\n

To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-none-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since\n

    \n
    • \n
\n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match condition evaluates to true

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false

    \n
    • \n
\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n
    \n
  • \n

    \n x-amz-copy-source-if-none-match condition evaluates to false

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since condition evaluates to\n true

    \n
    • \n
\n \n

All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.

\n \n
\n
Server-side encryption
\n
\n

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy\n request, the encryption setting of the target object is set to the default\n encryption configuration of the destination bucket. By default, all buckets have a\n base level of encryption configuration that uses server-side encryption with Amazon S3\n managed keys (SSE-S3). If the destination bucket has a default encryption\n configuration that uses server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or\n server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses\n the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.

\n

When you perform a CopyObject operation, if you want to use a different type\n of encryption setting for the target object, you can use other appropriate\n encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed\n key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it\n writes your data to disks in its data centers and decrypts the data when you access it. If the\n encryption setting in your request is different from the default encryption configuration\n of the destination bucket, the encryption setting in your request takes precedence. If the\n source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary\n encryption information in your request so that Amazon S3 can decrypt the object for copying. For\n more information about server-side encryption, see Using Server-Side\n Encryption.

\n

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the\n object. For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.

\n
\n
Access Control List (ACL)-Specific Request\n Headers
\n
\n

When copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.

\n

If the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use\n this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format.

\n

For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.

\n \n

If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.

\n \n
\n
Checksums
\n
\n

When copying an object, if it has a checksum, that checksum will be copied to the new\n object by default. When you copy the object over, you can optionally specify a different\n checksum algorithm to use with the x-amz-checksum-algorithm header.

\n
\n
Storage Class Options
\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 StorageClass parameter. For more\n information, see Storage Classes in the\n Amazon S3 User Guide.

\n

If the source object's storage class is GLACIER, you must restore a copy of\n this object before you can use it as a source object for the copy operation. For\n more information, see RestoreObject. For\n more information, see Copying\n Objects.

\n
\n
Versioning
\n
\n

By default, x-amz-copy-source header identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.

\n

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.

\n
\n
\n

The following operations are related to CopyObject:

\n ", - "smithy.api#examples": [ - { - "title": "To copy an object", - "documentation": "The following example copies an object from one bucket to another.", - "input": { - "Bucket": "destinationbucket", - "CopySource": "/sourcebucket/HappyFacejpg", - "Key": "HappyFaceCopyjpg" - }, - "output": { - "CopyObjectResult": { - "LastModified": "2016-12-15T17:38:53.000Z", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=CopyObject", @@ -21946,7 +21917,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the destination bucket.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The name of the destination bucket.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22376,18 +22347,6 @@ ], "traits": { "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of\n buckets.

\n \n
\n
Permissions
\n
\n

In addition to s3:CreateBucket, the following permissions are required when\n your CreateBucket request includes specific headers:

\n
    \n
  • \n

    \n Access control lists (ACLs) - If your CreateBucket request\n specifies access control list (ACL) permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through any other\n ACL, both s3:CreateBucket and s3:PutBucketAcl permissions\n are needed. If the ACL for the CreateBucket request is private or if the request doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.

    \n
    • \n
  • \n

    \n Object Lock - If ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.

    \n
    • \n
  • \n

    \n S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the\n s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are disabled. We recommend keeping\n ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the ObjectOwnership setting, you can use the \n x-amz-object-ownership header in your CreateBucket request to set the ObjectOwnership setting of your choice.\n For more information about S3 Object Ownership, see Controlling object\n ownership in the Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the \n DeletePublicAccessBlock\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock permission. By default, all Block\n Public Access settings are enabled for new buckets. To avoid inadvertent exposure of\n your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see Blocking public\n access to your Amazon S3 storage in the Amazon S3 User Guide.

    \n
    • \n
\n
\n
\n \n

If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership\n and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information,\n see Setting Object\n Ownership on an existing bucket in the Amazon S3 User Guide.

\n \n

The following operations are related to CreateBucket:

\n ", - "smithy.api#examples": [ - { - "title": "To create a bucket ", - "documentation": "The following example creates a bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Location": "/examplebucket" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}", @@ -22522,21 +22481,6 @@ }, "traits": { "smithy.api#documentation": "

This action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.

\n

For more information about multipart uploads, see Multipart Upload Overview.

\n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

\n

For information about the permissions required to use the multipart upload API, see\n Multipart\n Upload and Permissions.

\n

For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. Amazon S3\n automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a\n multipart upload, if you don't specify encryption information in your request, the\n encryption setting of the uploaded parts is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded\n parts. When you perform a CreateMultipartUpload operation, if you want to use a different\n type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the\n object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption\n setting in your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence. If you choose\n to provide your own encryption key, the request headers you provide in UploadPart\n and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload. You can request that Amazon S3\n save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key\n (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key\n (SSE-C).

\n

To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester\n must have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions and Protecting data using\n server-side encryption with Amazon Web Services KMS in the\n Amazon S3 User Guide.

\n

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key,\n then you must have these permissions on the key policy. If your IAM user or role belongs\n to a different account than the key, then you must have the permissions on both the key\n policy and your IAM user or role.

\n

For more information, see Protecting Data Using Server-Side\n Encryption.

\n
\n
Access Permissions
\n
\n

When copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. For\n more information, see Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL) Overview.

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Server-Side- Encryption-Specific Request Headers
\n
\n

Amazon S3 encrypts data\n by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can request that Amazon S3 encrypts\n data at rest by using server-side encryption with other key options. The option you use depends on\n whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys\n (SSE-C).

\n
    \n
  • \n

    Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key\n (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you\n want Amazon Web Services to manage the keys used to encrypt data, specify the following\n headers in the request.

    \n
      \n
    • \n

      \n x-amz-server-side-encryption\n

      \n
      • \n
    • \n

      \n x-amz-server-side-encryption-aws-kms-key-id\n

      \n
      • \n
    • \n

      \n x-amz-server-side-encryption-context\n

      \n
      • \n
    \n \n

    If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to\n protect the data.

    \n     \n \n

    All GET and PUT requests for an object protected\n by KMS fail if you don't make them by using Secure Sockets Layer (SSL),\n Transport Layer Security (TLS), or Signature Version 4.

    \n     \n

    For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting Data\n Using Server-Side Encryption with KMS keys.

    \n
    • \n
  • \n

    Use customer-provided encryption keys (SSE-C) – If you want to manage\n your own encryption keys, provide all the following headers in the\n request.

    \n
      \n
    • \n

      \n x-amz-server-side-encryption-customer-algorithm\n

      \n
      • \n
    • \n

      \n x-amz-server-side-encryption-customer-key\n

      \n
      • \n
    • \n

      \n x-amz-server-side-encryption-customer-key-MD5\n

      \n
      • \n
    \n

    For more information about server-side encryption with customer-provided\n encryption keys (SSE-C), see \n Protecting data using server-side encryption with customer-provided\n encryption keys (SSE-C).

    \n
    • \n
\n
\n
Access-Control-List (ACL)-Specific Request Headers
\n
\n

You also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual\n Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then\n added to the access control list (ACL) on the object. For more information, see\n Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:

\n
    \n
  • \n

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly — To explicitly grant access\n permissions to specific Amazon Web Services accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview. In the header, you specify a list of grantees who get\n the specific permission. To grant permissions explicitly, use:

    \n
      \n
    • \n

      \n x-amz-grant-read\n

      \n
      • \n
    • \n

      \n x-amz-grant-write\n

      \n
      • \n
    • \n

      \n x-amz-grant-read-acp\n

      \n
      • \n
    • \n

      \n x-amz-grant-write-acp\n

      \n
      • \n
    • \n

      \n x-amz-grant-full-control\n

      \n
      • \n
    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
    • \n
\n
\n
\n

The following operations are related to CreateMultipartUpload:

\n ", - "smithy.api#examples": [ - { - "title": "To initiate a multipart upload", - "documentation": "The following example initiates a multipart upload.", - "input": { - "Bucket": "examplebucket", - "Key": "largeobject" - }, - "output": { - "Bucket": "examplebucket", - "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--", - "Key": "largeobject" - } - } - ], "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?uploads&x-id=CreateMultipartUpload", @@ -22564,7 +22508,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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. Does not return the\n access point ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#xmlName": "Bucket" } }, @@ -22655,7 +22599,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which to initiate the upload

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which to initiate the upload

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22948,15 +22892,6 @@ }, "traits": { "smithy.api#documentation": "

Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.

\n

The following operations are related to DeleteBucket:

\n ", - "smithy.api#examples": [ - { - "title": "To delete a bucket", - "documentation": "The following example deletes the specified bucket.", - "input": { - "Bucket": "forrandall2" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}", @@ -23025,15 +22960,6 @@ }, "traits": { "smithy.api#documentation": "

Deletes the cors configuration information set for the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.

\n

For information about cors, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.

\n

\n Related Resources\n

\n ", - "smithy.api#examples": [ - { - "title": "To delete cors configuration on a bucket.", - "documentation": "The following example deletes CORS configuration on a bucket.", - "input": { - "Bucket": "examplebucket" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?cors", @@ -23215,15 +23141,6 @@ }, "traits": { "smithy.api#documentation": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.

\n

To use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.

\n

There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.

\n

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

\n

Related actions include:

\n ", - "smithy.api#examples": [ - { - "title": "To delete lifecycle configuration on a bucket.", - "documentation": "The following example deletes lifecycle configuration on a bucket.", - "input": { - "Bucket": "examplebucket" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?lifecycle", @@ -23361,15 +23278,6 @@ }, "traits": { "smithy.api#documentation": "

This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n Amazon Web Services account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.

\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

\n \n

For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.

\n

The following operations are related to DeleteBucketPolicy\n

\n ", - "smithy.api#examples": [ - { - "title": "To delete bucket policy", - "documentation": "The following example deletes bucket policy on the specified bucket.", - "input": { - "Bucket": "examplebucket" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?policy", @@ -23413,15 +23321,6 @@ }, "traits": { "smithy.api#documentation": "

Deletes the replication configuration from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n \n

It can take a while for the deletion of a replication configuration to fully\n propagate.

\n \n

For information about replication configuration, see Replication in the\n Amazon S3 User Guide.

\n

The following operations are related to DeleteBucketReplication:

\n ", - "smithy.api#examples": [ - { - "title": "To delete bucket replication configuration", - "documentation": "The following example deletes replication configuration set on bucket.", - "input": { - "Bucket": "example" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?replication", @@ -23491,15 +23390,6 @@ }, "traits": { "smithy.api#documentation": "

Deletes the tags from the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

The following operations are related to DeleteBucketTagging:

\n ", - "smithy.api#examples": [ - { - "title": "To delete bucket tags", - "documentation": "The following example deletes bucket tags.", - "input": { - "Bucket": "examplebucket" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?tagging", @@ -23543,15 +23433,6 @@ }, "traits": { "smithy.api#documentation": "

This action removes the website configuration for a bucket. Amazon S3 returns a 200\n OK response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if\n the bucket specified in the request does not exist.

\n

This DELETE action requires the S3:DeleteBucketWebsite permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite\n permission.

\n

For more information about hosting websites, see Hosting Websites on Amazon S3.

\n

The following operations are related to DeleteBucketWebsite:

\n ", - "smithy.api#examples": [ - { - "title": "To delete bucket website configuration", - "documentation": "The following example deletes bucket website configuration.", - "input": { - "Bucket": "examplebucket" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?website", @@ -23680,17 +23561,6 @@ }, "traits": { "smithy.api#documentation": "

Removes the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects but will still respond that the command was successful.

\n

To remove a specific version, you must use the version Id subresource. Using this\n subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header, x-amz-delete-marker, to true.

\n

If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.

\n

For more information about MFA Delete, see Using MFA Delete. To see sample\n requests that use versioning, see Sample\n Request.

\n

You can delete objects by explicitly calling DELETE Object or configure its lifecycle\n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject, s3:DeleteObjectVersion, and\n s3:PutLifeCycleConfiguration actions.

\n

The following action is related to DeleteObject:

\n ", - "smithy.api#examples": [ - { - "title": "To delete an object", - "documentation": "The following example deletes an object from an S3 bucket.", - "input": { - "Bucket": "examplebucket", - "Key": "objectkey.jpg" - }, - "output": {} - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}/{Key+}?x-id=DeleteObject", @@ -23733,7 +23603,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -23799,20 +23669,6 @@ }, "traits": { "smithy.api#documentation": "

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.

\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n

The following operations are related to DeleteObjectTagging:

\n ", - "smithy.api#examples": [ - { - "title": "To remove tag set from an object version", - "documentation": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", - "input": { - "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" - }, - "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" - } - } - ], "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}/{Key+}?tagging", @@ -23841,7 +23697,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -23933,7 +23789,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the objects to delete.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -24155,7 +24011,7 @@ } }, "traits": { - "smithy.api#documentation": "

Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n characters that are not supported in XML 1.0, you can add this parameter to request that\n Amazon S3 encode the keys in the response.

" + "smithy.api#documentation": "

Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n method to use. An object key can contain any Unicode character; however, the XML 1.0 parser\n cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n characters that are not supported in XML 1.0, you can add this parameter to request that\n Amazon S3 encode the keys in the response.

" } }, "com.amazonaws.s3#Encryption": { @@ -24830,31 +24686,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketCORS action. By default, the bucket owner has this permission\n and can grant it to others.

\n

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

\n

To use this API operation against 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

For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.

\n

The following operations are related to GetBucketCors:

\n ", - "smithy.api#examples": [ - { - "title": "To get cors configuration set on a bucket", - "documentation": "The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "CORSRules": [ - { - "AllowedHeaders": [ - "Authorization" - ], - "MaxAgeSeconds": 3000, - "AllowedMethods": [ - "GET" - ], - "AllowedOrigins": [ - "*" - ] - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?cors", @@ -25097,30 +24928,6 @@ }, "traits": { "smithy.api#documentation": "\n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier action, see GetBucketLifecycle.

\n \n

Returns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.

\n

To use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

\n GetBucketLifecycleConfiguration has the following special error:

\n \n

The following operations are related to\n GetBucketLifecycleConfiguration:

\n ", - "smithy.api#examples": [ - { - "title": "To get lifecycle configuration on a bucket", - "documentation": "The following example retrieves lifecycle configuration on set on a bucket. ", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Rules": [ - { - "Prefix": "TaxDocs", - "Status": "Enabled", - "Transitions": [ - { - "Days": 365, - "StorageClass": "STANDARD_IA" - } - ], - "ID": "Rule for TaxDocs/" - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?lifecycle", @@ -25182,18 +24989,6 @@ "traits": { "aws.customizations#s3UnwrappedXmlOutput": {}, "smithy.api#documentation": "

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

\n

To use this API operation against 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

We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.

\n \n

The following operations are related to GetBucketLocation:

\n ", - "smithy.api#examples": [ - { - "title": "To get bucket location", - "documentation": "The following example returns bucket location.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "LocationConstraint": "us-west-2" - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?location", @@ -25474,18 +25269,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

\n \n

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

\n

To use this API operation against 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

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n

The following action is related to GetBucketPolicy:

\n ", - "smithy.api#examples": [ - { - "title": "To get bucket policy", - "documentation": "The following example returns bucket policy associated with a bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}" - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?policy", @@ -25602,30 +25385,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the replication configuration of a bucket.

\n \n

It can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.

\n \n

For information about replication configuration, see Replication in the\n Amazon S3 User Guide.

\n

This action requires permissions for the s3:GetReplicationConfiguration\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.

\n

If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication and Priority elements.\n The response also returns those elements.

\n

For information about GetBucketReplication errors, see List of\n replication-related error codes\n

\n

The following operations are related to GetBucketReplication:

\n ", - "smithy.api#examples": [ - { - "title": "To get replication configuration set on a bucket", - "documentation": "The following example returns replication configuration set on a bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "ReplicationConfiguration": { - "Rules": [ - { - "Status": "Enabled", - "Prefix": "Tax", - "Destination": { - "Bucket": "arn:aws:s3:::destination-bucket" - }, - "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy" - } - ], - "Role": "arn:aws:iam::acct-id:role/example-role" - } - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?replication", @@ -25683,18 +25442,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.

\n

The following operations are related to GetBucketRequestPayment:

\n ", - "smithy.api#examples": [ - { - "title": "To get bucket versioning configuration", - "documentation": "The following example retrieves bucket versioning configuration.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Payer": "BucketOwner" - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?requestPayment", @@ -25753,27 +25500,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the tag set associated with the bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

\n GetBucketTagging has the following special error:

\n \n

The following operations are related to GetBucketTagging:

\n ", - "smithy.api#examples": [ - { - "title": "To get tag set associated with a bucket", - "documentation": "The following example returns tag set associated with a bucket", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "TagSet": [ - { - "Value": "value1", - "Key": "key1" - }, - { - "Value": "value2", - "Key": "key2" - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?tagging", @@ -25833,19 +25559,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the versioning state of a bucket.

\n

To retrieve the versioning state of a bucket, you must be the bucket owner.

\n

This implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled, the bucket owner must use an authentication\n device to change the versioning state of the bucket.

\n

The following operations are related to GetBucketVersioning:

\n ", - "smithy.api#examples": [ - { - "title": "To get bucket versioning configuration", - "documentation": "The following example retrieves bucket versioning configuration.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "Status": "Enabled", - "MFADelete": "Disabled" - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?versioning", @@ -25911,23 +25624,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.

\n

This GET action requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.

\n

The following operations are related to GetBucketWebsite:

\n ", - "smithy.api#examples": [ - { - "title": "To get bucket website configuration", - "documentation": "The following example retrieves website configuration of a bucket.", - "input": { - "Bucket": "examplebucket" - }, - "output": { - "IndexDocument": { - "Suffix": "index.html" - }, - "ErrorDocument": { - "Key": "error.html" - } - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?website", @@ -26043,56 +25739,6 @@ ], "traits": { "smithy.api#documentation": "

Returns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl permissions or READ_ACP access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n

\n

This action is not supported by Amazon S3 on Outposts.

\n

By default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.

\n \n

The following operations are related to GetObjectAcl:

\n ", - "smithy.api#examples": [ - { - "title": "To retrieve object ACL", - "documentation": "The following example retrieves access control list (ACL) of an object.", - "input": { - "Bucket": "examplebucket", - "Key": "HappyFace.jpg" - }, - "output": { - "Owner": { - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Grants": [ - { - "Grantee": { - "Type": "CanonicalUser", - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Permission": "WRITE" - }, - { - "Grantee": { - "Type": "CanonicalUser", - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Permission": "WRITE_ACP" - }, - { - "Grantee": { - "Type": "CanonicalUser", - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Permission": "READ" - }, - { - "Grantee": { - "Type": "CanonicalUser", - "DisplayName": "owner-display-name", - "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "Permission": "READ_ACP" - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?acl", @@ -26320,7 +25966,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -26395,7 +26041,7 @@ "ObjectAttributes": { "target": "com.amazonaws.s3#ObjectAttributesList", "traits": { - "smithy.api#documentation": "

An XML header that specifies the fields at the root level that you want returned in the\n response. Fields that you do not specify are not returned.

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

Specifies the fields at the root level that you want returned in the\n response. Fields that you do not specify are not returned.

", "smithy.api#httpHeader": "x-amz-object-attributes", "smithy.api#required": {} } @@ -26814,7 +26460,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

\n

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

\n

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -27063,29 +26709,6 @@ }, "traits": { "smithy.api#documentation": "

Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.

\n

To use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging\n action.

\n

By default, the bucket owner has this permission and can grant this permission to\n others.

\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n

The following actions are related to GetObjectTagging:

\n ", - "smithy.api#examples": [ - { - "title": "To retrieve tag set of an object", - "documentation": "The following example retrieves tag set of an object.", - "input": { - "Bucket": "examplebucket", - "Key": "HappyFace.jpg" - }, - "output": { - "VersionId": "null", - "TagSet": [ - { - "Value": "Value4", - "Key": "Key4" - }, - { - "Value": "Value3", - "Key": "Key3" - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?tagging", @@ -27122,7 +26745,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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -27173,17 +26796,6 @@ }, "traits": { "smithy.api#documentation": "

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.

\n \n

You can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.

\n \n

To use GET, you must have READ access to the object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following action is related to GetObjectTorrent:

\n ", - "smithy.api#examples": [ - { - "title": "To retrieve torrent files for an object", - "documentation": "The following example retrieves torrent files of an object.", - "input": { - "Bucket": "examplebucket", - "Key": "HappyFace.jpg" - }, - "output": {} - } - ], "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?torrent", @@ -27430,15 +27042,6 @@ ], "traits": { "smithy.api#documentation": "

This action is useful to determine if a bucket exists and you have permission to access\n it. The action returns a 200 OK if the bucket exists and you have permission\n to access it.

\n

If the bucket does not exist or you do not have permission to access it, the\n HEAD request returns a generic 400 Bad Request, 403\n Forbidden or 404 Not Found code. A message body is not included, so\n you cannot determine the exception beyond these error codes.

\n

To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

To use this API operation against an access point, you must provide the alias of the access point in place of the\n bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to\n the access point hostname. The access point hostname takes the form\n AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.\n When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more\n information, see Using access points.

\n

To use this API operation against 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.

", - "smithy.api#examples": [ - { - "title": "To determine if bucket exists", - "documentation": "This operation checks to see if a bucket exists.", - "input": { - "Bucket": "acl1" - } - } - ], "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}", @@ -27482,7 +27085,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \n If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \n For more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \n If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \n For more information about InvalidAccessPointAliasError, see List of\n Error Codes.

\n

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -27810,7 +27413,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -28501,6 +28104,12 @@ "smithy.api#default": false } }, + "com.amazonaws.s3#IsRestoreInProgress": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.s3#IsTruncated": { "type": "boolean", "traits": { @@ -28847,7 +28456,7 @@ "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

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

The ContinuationToken that represents a placeholder from where this request\n should begin.

", "smithy.api#httpQuery": "continuation-token" } }, @@ -29011,7 +28620,7 @@ "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to continue the\n listing. The continuation token is an opaque value that Amazon S3 understands.

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

The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", "smithy.api#httpQuery": "continuation-token" } }, @@ -29097,7 +28706,7 @@ "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

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

The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list\n response to continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", "smithy.api#httpQuery": "continuation-token" } }, @@ -29123,32 +28732,6 @@ }, "traits": { "smithy.api#documentation": "

Returns a list of all buckets owned by the authenticated sender of the request. To use\n this operation, you must have the s3:ListAllMyBuckets permission.

\n

For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.

", - "smithy.api#examples": [ - { - "title": "To list all buckets", - "documentation": "The following example returns all the buckets owned by the sender of this request.", - "output": { - "Owner": { - "DisplayName": "own-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31" - }, - "Buckets": [ - { - "CreationDate": "2012-02-15T21:03:02.000Z", - "Name": "examplebucket" - }, - { - "CreationDate": "2011-07-24T19:33:50.000Z", - "Name": "examplebucket2" - }, - { - "CreationDate": "2010-12-17T00:56:49.000Z", - "Name": "examplebucket3" - } - ] - } - } - ], "smithy.api#http": { "method": "GET", "uri": "/", @@ -29271,7 +28854,7 @@ "EncodingType": { "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

\n

If you specify encoding-type request parameter, Amazon S3 includes this element\n in the response, and returns encoded key name values in the following response\n elements:

\n

\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.

" + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.

" } }, "RequestCharged": { @@ -29292,7 +28875,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29316,7 +28899,7 @@ "KeyMarker": { "target": "com.amazonaws.s3#KeyMarker", "traits": { - "smithy.api#documentation": "

Together with upload-id-marker, this parameter specifies the multipart upload after\n which listing should begin.

\n

If upload-id-marker is not specified, only the keys lexicographically\n greater than the specified key-marker will be included in the list.

\n

If upload-id-marker is specified, any multipart uploads for a key equal to\n the key-marker might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker.

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

Together with upload-id-marker, this parameter specifies the multipart\n upload after which listing should begin.

\n

If upload-id-marker is not specified, only the keys lexicographically\n greater than the specified key-marker will be included in the list.

\n

If upload-id-marker is specified, any multipart uploads for a key equal to\n the key-marker might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker.

", "smithy.api#httpQuery": "key-marker" } }, @@ -29331,7 +28914,7 @@ "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.)

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way that you'd use a folder in a file\n system.)

", "smithy.api#httpQuery": "prefix" } }, @@ -29369,47 +28952,7 @@ "target": "com.amazonaws.s3#ListObjectVersionsOutput" }, "traits": { - "smithy.api#documentation": "

Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.

\n \n

To use this operation, you must have permissions to perform the\n s3:ListBucketVersions action. Be aware of the name difference.

\n \n \n

A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.

\n \n

To use this operation, you must have READ access to the bucket.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operations are related to ListObjectVersions:

\n ", - "smithy.api#examples": [ - { - "title": "To list object versions", - "documentation": "The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.", - "input": { - "Bucket": "examplebucket", - "Prefix": "HappyFace.jpg" - }, - "output": { - "Versions": [ - { - "LastModified": "2016-12-15T01:19:41.000Z", - "VersionId": "null", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "StorageClass": "STANDARD", - "Key": "HappyFace.jpg", - "Owner": { - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "IsLatest": true, - "Size": 3191 - }, - { - "LastModified": "2016-12-13T00:58:26.000Z", - "VersionId": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "StorageClass": "STANDARD", - "Key": "HappyFace.jpg", - "Owner": { - "DisplayName": "owner-display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" - }, - "IsLatest": false, - "Size": 3191 - } - ] - } - } - ], + "smithy.api#documentation": "

Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.

\n \n

To use this operation, you must have permission to perform the\n s3:ListBucketVersions action. Be aware of the name difference.

\n \n \n

A 200 OK response can contain valid or invalid XML. Make sure to design\n your application to parse the contents of the response and handle it\n appropriately.

\n \n

To use this operation, you must have READ access to the bucket.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operations are related to ListObjectVersions:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?versions", @@ -29424,7 +28967,7 @@ "target": "com.amazonaws.s3#IsTruncated", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request using\n the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n another request to return the rest of the results.

" + "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request by\n using the NextKeyMarker and NextVersionIdMarker response\n parameters as a starting place in another request to return the rest of the results.

" } }, "KeyMarker": { @@ -29448,7 +28991,7 @@ "NextVersionIdMarker": { "target": "com.amazonaws.s3#NextVersionIdMarker", "traits": { - "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextVersionIdMarker specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker request parameter\n in a subsequent request.

" + "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextVersionIdMarker specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker\n request parameter in a subsequent request.

" } }, "Versions": { @@ -29482,7 +29025,7 @@ "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes. These groups are counted as one result against the max-keys\n limitation. These keys are not returned elsewhere in the response.

" + "smithy.api#documentation": "

The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes. These groups are counted as one result against the\n max-keys limitation. These keys are not returned elsewhere in the\n response.

" } }, "MaxKeys": { @@ -29502,7 +29045,7 @@ "EncodingType": { "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n

\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

" + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

" } }, "RequestCharged": { @@ -29534,7 +29077,7 @@ "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are counted as one\n result against the max-keys limitation. These keys are not returned elsewhere in the\n response.

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

A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are\n counted as one result against the max-keys limitation. These keys are not\n returned elsewhere in the response.

", "smithy.api#httpQuery": "delimiter" } }, @@ -29555,14 +29098,14 @@ "target": "com.amazonaws.s3#MaxKeys", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n If additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains true. To return the\n additional keys, see key-marker and version-id-marker.

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

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n If additional keys satisfy the search criteria, but were not returned because\n max-keys was exceeded, the response contains\n true. To return the additional keys,\n see key-marker and version-id-marker.

", "smithy.api#httpQuery": "max-keys" } }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.) You can\n use prefix with delimiter to roll up numerous objects into a single result under\n CommonPrefixes.

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

Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way that you'd use a folder in a file\n system.) You can use prefix with delimiter to roll up numerous\n objects into a single result under CommonPrefixes.

", "smithy.api#httpQuery": "prefix" } }, @@ -29585,6 +29128,13 @@ "traits": { "smithy.api#httpHeader": "x-amz-request-payer" } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response.\n Fields that you do not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } } }, "traits": { @@ -29632,7 +29182,7 @@ "NextMarker": { "target": "com.amazonaws.s3#NextMarker", "traits": { - "smithy.api#documentation": "

When response is truncated (the IsTruncated element value in the response is true), you\n can use the key name in this field as marker in the subsequent request to get next set of\n objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if\n you have delimiter request parameter specified. If response does not include the NextMarker\n and it is truncated, you can use the value of the last Key in the response as the marker in\n the subsequent request to get the next set of object keys.

" + "smithy.api#documentation": "

When the response is truncated (the IsTruncated element value in the\n response is true), you can use the key name in this field as the\n marker parameter in the subsequent request to get the next set of objects.\n Amazon S3 lists objects in alphabetical order.

\n \n

This element is returned only if you have the delimiter request\n parameter specified. If the response does not include the NextMarker\n element and it is truncated, you can use the value of the last Key element\n in the response as the marker parameter in the subsequent request to get\n the next set of object keys.

\n " } }, "Contents": { @@ -29670,7 +29220,7 @@ "CommonPrefixes": { "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when\n calculating the number of returns.

\n

A response can contain CommonPrefixes only if you specify a delimiter.

\n

CommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.

\n

CommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.

\n

For example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.

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

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when\n calculating the number of returns.

\n

A response can contain CommonPrefixes only if you specify a\n delimiter.

\n

\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by the\n delimiter.

\n

\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.

\n

For example, if the prefix is notes/ and the delimiter is a slash\n (/), as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.

", "smithy.api#xmlFlattened": {} } }, @@ -29698,7 +29248,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket containing the objects.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29709,7 +29259,7 @@ "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

A delimiter is a character you use to group keys.

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

A delimiter is a character that you use to group keys.

", "smithy.api#httpQuery": "delimiter" } }, @@ -29730,7 +29280,7 @@ "target": "com.amazonaws.s3#MaxKeys", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n

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

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.

", "smithy.api#httpQuery": "max-keys" } }, @@ -29754,6 +29304,13 @@ "smithy.api#documentation": "

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", "smithy.api#httpHeader": "x-amz-expected-bucket-owner" } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response.\n Fields that you do not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } } }, "traits": { @@ -29774,7 +29331,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys\n programmatically\n

\n

To use this operation, you must have READ access to the bucket.

\n

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform\n the s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n \n

This section describes the latest revision of this action. We recommend that you use\n this revised API for application development. For backward compatibility, Amazon S3 continues\n to support the prior version of this API, ListObjects.

\n \n

To get a list of your buckets, see ListBuckets.

\n

The following operations are related to ListObjectsV2:

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

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys\n programmatically in the Amazon S3 User Guide.

\n

To use this operation, you must have READ access to the bucket.

\n

To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform\n the s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n \n

This section describes the latest revision of this action. We recommend that you use\n this revised API operation for application development. For backward compatibility, Amazon S3\n continues to support the prior version of this API operation, ListObjects.

\n \n

To get a list of your buckets, see ListBuckets.

\n

The following operations are related to ListObjectsV2:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?list-type=2", @@ -29794,7 +29351,7 @@ "target": "com.amazonaws.s3#IsTruncated", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true if more keys are available\n to return. If the number of results exceeds that specified by MaxKeys, all of the results\n might not be returned.

" + "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true\n if more keys are available to return. If the number of results exceeds that specified by\n MaxKeys, all of the results might not be returned.

" } }, "Contents": { @@ -29807,7 +29364,7 @@ "Name": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

" } }, "Prefix": { @@ -29819,14 +29376,14 @@ "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the CommonPrefixes\n collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up\n result counts as only one return against the MaxKeys value.

" + "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first\n occurrence of the delimiter to be rolled up into a single result element in the\n CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys value.

" } }, "MaxKeys": { "target": "com.amazonaws.s3#MaxKeys", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" } }, "CommonPrefixes": { @@ -29839,20 +29396,20 @@ "EncodingType": { "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n

\n Delimiter, Prefix, Key, and StartAfter.

" + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n

If you specify the encoding-type request parameter, Amazon S3 includes this\n element in the response, and returns encoded key name values in the following response\n elements:

\n

\n Delimiter, Prefix, Key, and StartAfter.

" } }, "KeyCount": { "target": "com.amazonaws.s3#KeyCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

KeyCount is the number of keys returned with this request. KeyCount will always be less\n than or equal to the MaxKeys field. Say you ask for 50 keys, your result will\n include 50 keys or fewer.

" + "smithy.api#documentation": "

\n KeyCount is the number of keys returned with this request.\n KeyCount will always be less than or equal to the MaxKeys\n field. For example, if you ask for 50 keys, your result will include 50 keys or\n fewer.

" } }, "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the response.

" + "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the\n response.

" } }, "NextContinuationToken": { @@ -29885,7 +29442,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Bucket name to list.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

Bucket name to list.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -29896,7 +29453,7 @@ "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

A delimiter is a character you use to group keys.

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

A delimiter is a character that you use to group keys.

", "smithy.api#httpQuery": "delimiter" } }, @@ -29911,7 +29468,7 @@ "target": "com.amazonaws.s3#MaxKeys", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

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

Sets the maximum number of keys returned in the response. By default, the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.

", "smithy.api#httpQuery": "max-keys" } }, @@ -29925,7 +29482,7 @@ "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a\n token. ContinuationToken is obfuscated and is not a real key.

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

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real\n key.

", "smithy.api#httpQuery": "continuation-token" } }, @@ -29933,7 +29490,7 @@ "target": "com.amazonaws.s3#FetchOwner", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The owner field is not present in listV2 by default, if you want to return owner field\n with each key in the result then set the fetch owner field to true.

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

The owner field is not present in ListObjectsV2 by default. If you want to\n return the owner field with each key in the result, then set the FetchOwner\n field to true.

", "smithy.api#httpQuery": "fetch-owner" } }, @@ -29957,6 +29514,13 @@ "smithy.api#documentation": "

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

", "smithy.api#httpHeader": "x-amz-expected-bucket-owner" } + }, + "OptionalObjectAttributes": { + "target": "com.amazonaws.s3#OptionalObjectAttributesList", + "traits": { + "smithy.api#documentation": "

Specifies the optional fields that you want returned in the response.\n Fields that you do not specify are not returned.

", + "smithy.api#httpHeader": "x-amz-optional-object-attributes" + } } }, "traits": { @@ -30030,7 +29594,7 @@ "NextPartNumberMarker": { "target": "com.amazonaws.s3#NextPartNumberMarker", "traits": { - "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" + "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" } }, "MaxParts": { @@ -30097,7 +29661,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -30308,13 +29872,13 @@ "Name": { "target": "com.amazonaws.s3#MetadataKey", "traits": { - "smithy.api#documentation": "

Name of the Object.

" + "smithy.api#documentation": "

Name of the object.

" } }, "Value": { "target": "com.amazonaws.s3#MetadataValue", "traits": { - "smithy.api#documentation": "

Value of the Object.

" + "smithy.api#documentation": "

Value of the object.

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

The owner of the object

" } + }, + "RestoreStatus": { + "target": "com.amazonaws.s3#RestoreStatus", + "traits": { + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must be restored\n before they can be retrieved. For more information about these storage classes and how to work with\n archived objects, see \n Working with archived objects in the Amazon S3 User Guide.

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

Specifies the owner of the object.

" } + }, + "RestoreStatus": { + "target": "com.amazonaws.s3#RestoreStatus", + "traits": { + "smithy.api#documentation": "

Specifies the restoration status of an object. Objects in certain storage classes must be restored\n before they can be retrieved. For more information about these storage classes and how to work with\n archived objects, see \n Working with archived objects in the Amazon S3 User Guide.

" + } } }, "traits": { @@ -31273,6 +30849,23 @@ } } }, + "com.amazonaws.s3#OptionalObjectAttributes": { + "type": "enum", + "members": { + "RESTORE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RestoreStatus" + } + } + } + }, + "com.amazonaws.s3#OptionalObjectAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#OptionalObjectAttributes" + } + }, "com.amazonaws.s3#OutputLocation": { "type": "structure", "members": { @@ -31724,17 +31317,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have WRITE_ACP permission.

\n

You can use one of the following two ways to set a bucket's permissions:

\n \n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

You can set access permissions by using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.

    \n

    \n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>&\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n
\n
\n

The following operations are related to PutBucketAcl:

\n ", - "smithy.api#examples": [ - { - "title": "Put bucket acl", - "documentation": "The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.", - "input": { - "Bucket": "examplebucket", - "GrantFullControl": "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", - "GrantWrite": "uri=http://acs.amazonaws.com/groups/s3/LogDelivery" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?acl", @@ -31906,49 +31488,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.

\n

To use this operation, you must be allowed to perform the s3:PutBucketCORS\n action. By default, the bucket owner has this permission and can grant it to others.

\n

You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.

\n

To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.

\n

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:

\n \n

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.

\n

The following operations are related to PutBucketCors:

\n ", - "smithy.api#examples": [ - { - "title": "To set cors configuration on a bucket.", - "documentation": "The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.", - "input": { - "Bucket": "", - "CORSConfiguration": { - "CORSRules": [ - { - "AllowedOrigins": [ - "http://www.example.com" - ], - "AllowedHeaders": [ - "*" - ], - "AllowedMethods": [ - "PUT", - "POST", - "DELETE" - ], - "MaxAgeSeconds": 3000, - "ExposeHeaders": [ - "x-amz-server-side-encryption" - ] - }, - { - "AllowedOrigins": [ - "*" - ], - "AllowedHeaders": [ - "Authorization" - ], - "AllowedMethods": [ - "GET" - ], - "MaxAgeSeconds": 3000 - } - ] - }, - "ContentMD5": "" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?cors", @@ -32201,35 +31740,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.

\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.

\n \n
\n
Rules
\n
\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle\n configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists\n of the following:

\n
    \n
  • \n

    A filter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.

    \n
    • \n
  • \n

    A status indicating whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.

    \n
    • \n
\n

For more information, see Object Lifecycle Management\n and Lifecycle Configuration Elements.

\n
\n
Permissions
\n
\n

By default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.

\n

You can also explicitly deny permissions. An explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:

\n
    \n
  • \n

    \n s3:DeleteObject\n

    \n
    • \n
  • \n

    \n s3:DeleteObjectVersion\n

    \n
    • \n
  • \n

    \n s3:PutLifecycleConfiguration\n

    \n
    • \n
\n

For more information about permissions, see Managing Access Permissions to\n Your Amazon S3 Resources.

\n
\n
\n

The following operations are related to PutBucketLifecycleConfiguration:

\n ", - "smithy.api#examples": [ - { - "title": "Put bucket lifecycle", - "documentation": "The following example replaces existing lifecycle configuration, if any, on the specified bucket. ", - "input": { - "Bucket": "examplebucket", - "LifecycleConfiguration": { - "Rules": [ - { - "Filter": { - "Prefix": "documents/" - }, - "Status": "Enabled", - "Transitions": [ - { - "Days": 365, - "StorageClass": "GLACIER" - } - ], - "Expiration": { - "Days": 3650 - }, - "ID": "TestOnly" - } - ] - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?lifecycle", @@ -32292,30 +31802,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.

\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n \n

If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.

\n \n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights (by using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    \n DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl\n request, appears as the CanonicalUser.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
\n
\n
\n

To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:

\n

\n \n

\n

For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.

\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n

The following operations are related to PutBucketLogging:

\n ", - "smithy.api#examples": [ - { - "title": "Set logging configuration for a bucket", - "documentation": "The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.", - "input": { - "Bucket": "sourcebucket", - "BucketLoggingStatus": { - "LoggingEnabled": { - "TargetBucket": "targetbucket", - "TargetPrefix": "MyBucketLogs/", - "TargetGrants": [ - { - "Grantee": { - "Type": "Group", - "URI": "http://acs.amazonaws.com/groups/global/AllUsers" - }, - "Permission": "READ" - } - ] - } - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?logging", @@ -32442,25 +31928,6 @@ }, "traits": { "smithy.api#documentation": "

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n

\n \n

\n

\n \n

\n

This action replaces the existing notification configuration with the configuration you\n include in the request body.

\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.

\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n

For more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.

\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with the required s3:PutBucketNotification permission.

\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.

\n \n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n

The following action is related to\n PutBucketNotificationConfiguration:

\n ", - "smithy.api#examples": [ - { - "title": "Set notification configuration for a bucket", - "documentation": "The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.", - "input": { - "Bucket": "examplebucket", - "NotificationConfiguration": { - "TopicConfigurations": [ - { - "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic", - "Events": [ - "s3:ObjectCreated:*" - ] - } - ] - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?notification", @@ -32586,16 +32053,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n \n

To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

\n \n

For more information, see Bucket policy\n examples.

\n

The following operations are related to PutBucketPolicy:

\n ", - "smithy.api#examples": [ - { - "title": "Set bucket policy", - "documentation": "The following example sets a permission policy on a bucket.", - "input": { - "Bucket": "examplebucket", - "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?policy", @@ -32673,28 +32130,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.

\n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.

\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n
\n
Handling Replication of Encrypted Objects
\n
\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:\n SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using KMS keys.

\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n
\n
Permissions
\n
\n

To create a PutBucketReplication request, you must have\n s3:PutReplicationConfiguration permissions for the bucket.\n \n

\n

By default, a resource owner, in this case the Amazon Web Services account that created the bucket,\n can perform this operation. The resource owner can also grant others permissions to perform\n the operation. For more information about permissions, see Specifying Permissions in a\n Policy and Managing Access Permissions to\n Your Amazon S3 Resources.

\n \n

To perform this operation, the user or role performing the action must have the\n iam:PassRole permission.

\n \n
\n
\n

The following operations are related to PutBucketReplication:

\n ", - "smithy.api#examples": [ - { - "title": "Set replication configuration on a bucket", - "documentation": "The following example sets replication configuration on a bucket.", - "input": { - "Bucket": "examplebucket", - "ReplicationConfiguration": { - "Role": "arn:aws:iam::123456789012:role/examplerole", - "Rules": [ - { - "Prefix": "", - "Status": "Enabled", - "Destination": { - "Bucket": "arn:aws:s3:::destinationbucket", - "StorageClass": "STANDARD" - } - } - ] - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?replication", @@ -32771,18 +32206,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.

\n

The following operations are related to PutBucketRequestPayment:

\n ", - "smithy.api#examples": [ - { - "title": "Set request payment configuration on a bucket.", - "documentation": "The following example sets request payment configuration on a bucket so that person requesting the download is charged.", - "input": { - "Bucket": "examplebucket", - "RequestPaymentConfiguration": { - "Payer": "Requester" - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?requestPayment", @@ -32853,27 +32276,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the tags for a bucket.

\n

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation and\n Tagging and Using Cost Allocation in Amazon S3 Bucket\n Tags.

\n \n

When this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

\n PutBucketTagging has the following special errors:

\n \n

The following operations are related to PutBucketTagging:

\n ", - "smithy.api#examples": [ - { - "title": "Set tags on a bucket", - "documentation": "The following example sets tags on a bucket. Any existing tags are replaced.", - "input": { - "Bucket": "examplebucket", - "Tagging": { - "TagSet": [ - { - "Key": "Key1", - "Value": "Value1" - }, - { - "Key": "Key2", - "Value": "Value2" - } - ] - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?tagging", @@ -32944,19 +32346,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the versioning state of an existing bucket.

\n

You can set the versioning state with one of the following values:

\n

\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.

\n

\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.

\n

If the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.

\n

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request header and the Status and the\n MfaDelete request elements in a request to set the versioning state of the\n bucket.

\n \n

If you have an object expiration lifecycle configuration in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.

\n \n

The following operations are related to PutBucketVersioning:

\n ", - "smithy.api#examples": [ - { - "title": "Set versioning configuration on a bucket", - "documentation": "The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.", - "input": { - "Bucket": "examplebucket", - "VersioningConfiguration": { - "MFADelete": "Disabled", - "Status": "Enabled" - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?versioning", @@ -33034,24 +32423,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the configuration of the website that is specified in the website\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.

\n

This PUT action requires the S3:PutBucketWebsite permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite permission.

\n

To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.

\n \n

If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.

\n \n

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon S3 User Guide.

", - "smithy.api#examples": [ - { - "title": "Set website configuration on a bucket", - "documentation": "The following example adds website configuration to a bucket.", - "input": { - "Bucket": "examplebucket", - "ContentMD5": "", - "WebsiteConfiguration": { - "IndexDocument": { - "Suffix": "index.html" - }, - "ErrorDocument": { - "Key": "error.html" - } - } - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?website", @@ -33121,22 +32492,6 @@ "requestAlgorithmMember": "ChecksumAlgorithm" }, "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n \n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.

\n \n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.

\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n \n \n

You have four mutually exclusive options to protect data using server-side encryption in\n Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or\n DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side\n encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to\n encrypt data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption.

\n

When adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.

\n

If the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.

\n \n

If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.

\n \n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n

For more information about related Amazon S3 APIs, see the following:

\n ", - "smithy.api#examples": [ - { - "title": "To upload an object and specify optional tags", - "documentation": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", - "input": { - "Body": "c:\\HappyFace.jpg", - "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "Tagging": "key1=value1&key2=value2" - }, - "output": { - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=PutObject", @@ -33163,20 +32518,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.

\n

This action is not supported by Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.

\n \n

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.

\n \n
\n
Permissions
\n
\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an\n Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.

    \n

    \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n
\n
Grantee Values
\n
\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n
\n
Versioning
\n
\n

The ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.

\n
\n
\n

The following operations are related to PutObjectAcl:

\n ", - "smithy.api#examples": [ - { - "title": "To grant permissions using object ACL", - "documentation": "The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.", - "input": { - "AccessControlPolicy": {}, - "Bucket": "examplebucket", - "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com", - "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers", - "Key": "HappyFace.jpg" - }, - "output": {} - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?acl", @@ -33279,7 +32620,7 @@ "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

Key for which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

Key for which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33636,7 +32977,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -34015,31 +33356,6 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "

Sets the supplied tag-set to an object that already exists in a bucket.

\n

A tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.

\n

For tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.

\n

To use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.

\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n

\n PutObjectTagging has the following special errors:

\n \n

The following operations are related to PutObjectTagging:

\n ", - "smithy.api#examples": [ - { - "title": "To add tags to an existing object", - "documentation": "The following example adds tags to an existing object.", - "input": { - "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "Tagging": { - "TagSet": [ - { - "Key": "Key3", - "Value": "Value3" - }, - { - "Key": "Key4", - "Value": "Value4" - } - ] - } - }, - "output": { - "VersionId": "null" - } - } - ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?tagging", @@ -34068,7 +33384,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -34718,6 +34034,9 @@ "com.amazonaws.s3#Restore": { "type": "string" }, + "com.amazonaws.s3#RestoreExpiryDate": { + "type": "timestamp" + }, "com.amazonaws.s3#RestoreObject": { "type": "operation", "input": { @@ -34736,23 +34055,6 @@ "requestAlgorithmMember": "ChecksumAlgorithm" }, "smithy.api#documentation": "

Restores an archived copy of an object back into Amazon S3

\n

This action is not supported by Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n \n

For more information about the S3 structure in the request body, see the\n following:

\n \n

Define the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.

\n \n

When making a select request, you can also do the following:

\n \n

The following are additional important facts about the select feature:

\n \n
\n
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 default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n 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 or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage\n classes, you must first initiate a restore request, and then wait until a temporary copy of\n the object is available. If you want a permanent copy of the object, create a copy of it in\n the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must\n restore the object for the duration (number of days) that you specify. For objects in the\n Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first\n initiate a restore request, and then wait until the object is moved into the Frequent\n Access tier.

\n

To restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data access tier\n options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access your\n data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives\n are required. For all but the largest archived objects (250 MB+), data accessed using\n Expedited retrievals is typically made available within 1–5 minutes. Provisioned\n capacity ensures that retrieval capacity for Expedited retrievals is available when\n you need it. Expedited retrievals and provisioned capacity are not available for\n objects 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 your\n archived objects within several hours. This is the default option for retrieval\n requests that do not specify the retrieval option. Standard retrievals typically\n finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible\n Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within\n 12 hours for 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 in\n S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the S3 Glacier\n Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to\n retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically\n finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval\n Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are\n also the lowest-cost retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for objects\n stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\n tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in\n the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see 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 request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3\n Event Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management\n in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202 Accepted\n 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 the\n 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. (This error does not\n apply to SELECT type requests.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n 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", - "documentation": "The following example restores for one day an archived copy of an object back into Amazon S3 bucket.", - "input": { - "Bucket": "examplebucket", - "Key": "archivedobjectkey", - "RestoreRequest": { - "Days": 1, - "GlacierJobParameters": { - "Tier": "Expedited" - } - } - }, - "output": {} - } - ], "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?restore&x-id=RestoreObject", @@ -34787,7 +34089,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the object to restore.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -34907,6 +34209,27 @@ } } }, + "com.amazonaws.s3#RestoreStatus": { + "type": "structure", + "members": { + "IsRestoreInProgress": { + "target": "com.amazonaws.s3#IsRestoreInProgress", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the object is currently being restored. If the object restoration is\n in progress, the header returns the value TRUE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"true\"\n

\n

If the object restoration has completed, the header returns the value FALSE. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"false\", RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"\n

\n

If the object hasn't been restored, there is no header response.

" + } + }, + "RestoreExpiryDate": { + "target": "com.amazonaws.s3#RestoreExpiryDate", + "traits": { + "smithy.api#documentation": "

Indicates when the restored copy will expire. This value is populated only if the object\n has already been restored. For example:

\n

\n x-amz-optional-object-attributes: IsRestoreInProgress=\"false\", RestoreExpiryDate=\"2012-12-21T00:00:00.000Z\"\n

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

Specifies the restoration status of an object. Objects in certain storage classes must be restored\n before they can be retrieved. For more information about these storage classes and how to work with\n archived objects, see \n Working with archived objects in the Amazon S3 User Guide.

" + } + }, "com.amazonaws.s3#Role": { "type": "string" }, @@ -36031,7 +35354,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -36273,7 +35596,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, 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

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { diff --git a/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json b/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json index 405e202a532..45630393019 100644 --- a/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json +++ b/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json @@ -866,6 +866,12 @@ "smithy.api#documentation": "

A list of FeatureGroup names, with their corresponding\n RecordIdentifier value, and Feature name that have been requested to be\n retrieved in batch.

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

Parameter to request ExpiresAt in response. If Enabled,\n BatchGetRecord will return the value of ExpiresAt, if it is\n not null. If Disabled and null, BatchGetRecord will return\n null.

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

The Record retrieved.

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

The ExpiresAt ISO string of the requested record.

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

Deletes a Record from a FeatureGroup in the\n OnlineStore. Feature Store supports both SOFT_DELETE and\n HARD_DELETE. For SOFT_DELETE (default), feature columns are\n set to null and the record is no longer retrievable by GetRecord\n or BatchGetRecord. For HARD_DELETE, the complete\n Record is removed from the OnlineStore. In both cases, Feature\n Store appends the deleted record marker to the OfflineStore with feature\n values set to null, is_deleted value set to True,\n and EventTime set to the delete input EventTime.

\n

Note that the EventTime specified in DeleteRecord should be\n set later than the EventTime of the existing record in the\n OnlineStore for that RecordIdentifer. If it is not, the\n deletion does not occur:

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

Deletes a Record from a FeatureGroup in the\n OnlineStore. Feature Store supports both SoftDelete and\n HardDelete. For SoftDelete (default), feature columns are\n set to null and the record is no longer retrievable by GetRecord\n or BatchGetRecord. For HardDelete, the complete\n Record is removed from the OnlineStore. In both cases, Feature\n Store appends the deleted record marker to the OfflineStore with feature\n values set to null, is_deleted value set to True,\n and EventTime set to the delete input EventTime.

\n

Note that the EventTime specified in DeleteRecord should be\n set later than the EventTime of the existing record in the\n OnlineStore for that RecordIdentifer. If it is not, the\n deletion does not occur:

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/FeatureGroup/{FeatureGroupName}", @@ -1035,6 +1047,26 @@ } } }, + "com.amazonaws.sagemakerfeaturestoreruntime#ExpirationTimeResponse": { + "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.sagemakerfeaturestoreruntime#ExpiresAt": { + "type": "string" + }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupName": { "type": "string", "traits": { @@ -1147,6 +1179,13 @@ "smithy.api#documentation": "

List of names of Features to be retrieved. If not specified, the latest value for all\n the Features are returned.

", "smithy.api#httpQuery": "FeatureName" } + }, + "ExpirationTimeResponse": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpirationTimeResponse", + "traits": { + "smithy.api#documentation": "

Parameter to request ExpiresAt in response. If Enabled,\n BatchGetRecord will return the value of ExpiresAt, if it is\n not null. If Disabled and null, BatchGetRecord will return\n null.

", + "smithy.api#httpQuery": "ExpirationTimeResponse" + } } }, "traits": { @@ -1161,6 +1200,12 @@ "traits": { "smithy.api#documentation": "

The record you requested. A list of FeatureValues.

" } + }, + "ExpiresAt": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#ExpiresAt", + "traits": { + "smithy.api#documentation": "

The ExpiresAt ISO string of the requested record.

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

A list of stores to which you're adding the record. By default, Feature Store adds the\n record to all of the stores that you're using for the FeatureGroup.

" } + }, + "TtlDuration": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration", + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } } }, "traits": { @@ -1327,6 +1378,71 @@ } } }, + "com.amazonaws.sagemakerfeaturestoreruntime#TtlDuration": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationUnit", + "traits": { + "smithy.api#documentation": "

\n TtlDuration time unit.

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

\n TtlDuration time value.

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

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } + }, + "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minutes" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hours" + } + }, + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Days" + } + }, + "WEEKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weeks" + } + } + } + }, + "com.amazonaws.sagemakerfeaturestoreruntime#TtlDurationValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedIdentifiers": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index e180337e468..cd527e8608f 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -5998,7 +5998,7 @@ "ModelDataSource": { "target": "com.amazonaws.sagemaker#ModelDataSource", "traits": { - "smithy.api#documentation": "

Specifies the location of ML model data to deploy.

\n \n

Currently you cannot use ModelDataSource in conjuction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.

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

Specifies the location of ML model data to deploy.

\n \n

Currently you cannot use ModelDataSource in conjunction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.

\n " } } }, @@ -9833,7 +9833,7 @@ "PipelineDefinition": { "target": "com.amazonaws.sagemaker#PipelineDefinition", "traits": { - "smithy.api#documentation": "

The JSON pipeline definition of the pipeline.

" + "smithy.api#documentation": "

The JSON \n pipeline definition of the pipeline.

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

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

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

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.\n

" + } } }, "traits": { @@ -41546,12 +41552,32 @@ "smithy.api#default": false, "smithy.api#documentation": "

Turn OnlineStore off by specifying False \n for the EnableOnlineStore flag. Turn OnlineStore \n on by specifying True \n for the EnableOnlineStore flag.

\n

The default value is False.

" } + }, + "TtlDuration": { + "target": "com.amazonaws.sagemaker#TtlDuration", + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

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

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly.

\n

The default value is False.

" } }, + "com.amazonaws.sagemaker#OnlineStoreConfigUpdate": { + "type": "structure", + "members": { + "TtlDuration": { + "target": "com.amazonaws.sagemaker#TtlDuration", + "traits": { + "smithy.api#documentation": "

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

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

Updates the feature group online store configuration.

" + } + }, "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { "type": "structure", "members": { @@ -47844,14 +47870,14 @@ "S3DataType": { "target": "com.amazonaws.sagemaker#S3ModelDataType", "traits": { - "smithy.api#documentation": "

Specifies the type of ML model data to deploy.

\n

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).

\n

If you choose S3Object, S3Uri identifies an object that is the ML model data to\n deploy.

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

Specifies the type of ML model data to deploy.

\n

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).

\n

If you choose S3Object, S3Uri identifies an object that is\n the ML model data to deploy.

", "smithy.api#required": {} } }, "CompressionType": { "target": "com.amazonaws.sagemaker#ModelCompressionType", "traits": { - "smithy.api#documentation": "

Specifies how the ML model data is prepared.

\n

If you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.

\n

If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.

\n

If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.

\n

If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:

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

Specifies how the ML model data is prepared.

\n

If you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.

\n

If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.

\n

If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.

\n

If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:

\n ", "smithy.api#required": {} } } @@ -55815,6 +55841,69 @@ "smithy.api#documentation": "

A summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName.

" } }, + "com.amazonaws.sagemaker#TtlDuration": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.sagemaker#TtlDurationUnit", + "traits": { + "smithy.api#documentation": "

\n TtlDuration time unit.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#TtlDurationValue", + "traits": { + "smithy.api#documentation": "

\n TtlDuration time value.

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

Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" + } + }, + "com.amazonaws.sagemaker#TtlDurationUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minutes" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hours" + } + }, + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Days" + } + }, + "WEEKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Weeks" + } + } + } + }, + "com.amazonaws.sagemaker#TtlDurationValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#TuningJobCompletionCriteria": { "type": "structure", "members": { @@ -56640,6 +56729,12 @@ "traits": { "smithy.api#documentation": "

Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.

" } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfigUpdate", + "traits": { + "smithy.api#documentation": "

Updates the feature group online store configuration.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sfn.json b/codegen/sdk/aws-models/sfn.json index 6d649a0e972..92764ad2580 100644 --- a/codegen/sdk/aws-models/sfn.json +++ b/codegen/sdk/aws-models/sfn.json @@ -39,12 +39,21 @@ { "target": "com.amazonaws.sfn#CreateStateMachine" }, + { + "target": "com.amazonaws.sfn#CreateStateMachineAlias" + }, { "target": "com.amazonaws.sfn#DeleteActivity" }, { "target": "com.amazonaws.sfn#DeleteStateMachine" }, + { + "target": "com.amazonaws.sfn#DeleteStateMachineAlias" + }, + { + "target": "com.amazonaws.sfn#DeleteStateMachineVersion" + }, { "target": "com.amazonaws.sfn#DescribeActivity" }, @@ -57,6 +66,9 @@ { "target": "com.amazonaws.sfn#DescribeStateMachine" }, + { + "target": "com.amazonaws.sfn#DescribeStateMachineAlias" + }, { "target": "com.amazonaws.sfn#DescribeStateMachineForExecution" }, @@ -75,12 +87,21 @@ { "target": "com.amazonaws.sfn#ListMapRuns" }, + { + "target": "com.amazonaws.sfn#ListStateMachineAliases" + }, { "target": "com.amazonaws.sfn#ListStateMachines" }, + { + "target": "com.amazonaws.sfn#ListStateMachineVersions" + }, { "target": "com.amazonaws.sfn#ListTagsForResource" }, + { + "target": "com.amazonaws.sfn#PublishStateMachineVersion" + }, { "target": "com.amazonaws.sfn#SendTaskFailure" }, @@ -110,6 +131,9 @@ }, { "target": "com.amazonaws.sfn#UpdateStateMachine" + }, + { + "target": "com.amazonaws.sfn#UpdateStateMachineAlias" } ], "traits": { @@ -1241,7 +1265,7 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the activity.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the activity.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -1384,6 +1408,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.sfn#AliasDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.sfn#Arn": { "type": "string", "traits": { @@ -1433,6 +1467,16 @@ "smithy.api#documentation": "

An object that describes workflow billing details.

" } }, + "com.amazonaws.sfn#CharacterRestrictedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#pattern": "^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$" + } + }, "com.amazonaws.sfn#CloudWatchEventsExecutionDataDetails": { "type": "structure", "members": { @@ -1462,6 +1506,19 @@ "smithy.api#documentation": "

" } }, + "com.amazonaws.sfn#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

\n

HTTP Status Code: 409

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.sfn#ConnectorParameters": { "type": "string", "traits": { @@ -1492,7 +1549,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an activity. An activity is a task that you write in any programming language and\n host on any machine that has access to Step Functions. Activities must poll Step Functions using the\n GetActivityTask API action and respond using SendTask* API\n actions. This function lets Step Functions know the existence of your activity and returns an\n identifier for use in a state machine and when polling from the activity.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n \n

\n CreateActivity is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateActivity's idempotency\n check is based on the activity name. If a following request has different\n tags values, Step Functions will ignore these differences and treat it as an\n idempotent request of the previous. In this case, tags will not be updated,\n even if they are different.

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

Creates an activity. An activity is a task that you write in any programming language and\n host on any machine that has access to Step Functions. Activities must poll Step Functions using the\n GetActivityTask API action and respond using SendTask* API\n actions. This function lets Step Functions know the existence of your activity and returns an\n identifier for use in a state machine and when polling from the activity.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n \n

\n CreateActivity is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateActivity's idempotency\n check is based on the activity name. If a following request has different\n tags values, Step Functions will ignore these differences and treat it as an\n idempotent request of the previous. In this case, tags will not be updated,\n even if they are different.

\n ", "smithy.api#idempotent": {} } }, @@ -1502,16 +1559,19 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.sfn#TagList", "traits": { - "smithy.api#documentation": "

The list of tags to add to a resource.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

The list of tags to add to a resource.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#CreateActivityOutput": { @@ -1531,6 +1591,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#CreateStateMachine": { @@ -1542,6 +1605,9 @@ "target": "com.amazonaws.sfn#CreateStateMachineOutput" }, "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, { "target": "com.amazonaws.sfn#InvalidArn" }, @@ -1571,20 +1637,108 @@ }, { "target": "com.amazonaws.sfn#TooManyTags" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Creates a state machine. A state machine consists of a collection of states that can do\n work (Task states), determine to which states to transition next\n (Choice states), stop an execution with an error (Fail states),\n and so on. State machines are specified using a JSON-based, structured language. For more\n information, see Amazon States\n Language in the Step Functions User Guide.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n \n

\n CreateStateMachine is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateStateMachine's idempotency\n check is based on the state machine name, definition,\n type, LoggingConfiguration and\n TracingConfiguration. If a following request has a different\n roleArn or tags, Step Functions will ignore these differences and treat\n it as an idempotent request of the previous. In this case, roleArn and\n tags will not be updated, even if they are different.

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

Creates a state machine. A state machine consists of a collection of states that can do\n work (Task states), determine to which states to transition next\n (Choice states), stop an execution with an error (Fail states),\n and so on. State machines are specified using a JSON-based, structured language. For more\n information, see Amazon States\n Language in the Step Functions User Guide.

\n

If you set the publish parameter of this API action to true, it\n publishes version 1 as the first revision of the state machine.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n \n

\n CreateStateMachine is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateStateMachine's idempotency\n check is based on the state machine name, definition,\n type, LoggingConfiguration, and\n TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different\n roleArn or tags, Step Functions will ignore these differences and treat\n it as an idempotent request of the previous. In this case, roleArn and\n tags will not be updated, even if they are different.

\n ", "smithy.api#idempotent": {} } }, + "com.amazonaws.sfn#CreateStateMachineAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#CreateStateMachineAliasInput" + }, + "output": { + "target": "com.amazonaws.sfn#CreateStateMachineAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#InvalidName" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.sfn#StateMachineDeleting" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

\n

You can also map an alias to split StartExecution requests between two\n versions of a state machine. To do this, add a second RoutingConfig object in the\n routingConfiguration parameter. You must also specify the percentage of\n execution run requests each version should receive in both RoutingConfig objects.\n Step Functions randomly chooses which version runs a given execution based on the\n percentage you specify.

\n

To create an alias that points to a single version, specify a single\n RoutingConfig object with a weight set to 100.

\n

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

\n

\n CreateStateMachineAlias is an idempotent API. Step Functions bases the\n idempotency check on the stateMachineArn, description,\n name, and routingConfiguration parameters. Requests that contain\n the same values for these parameters return a successful idempotent response without creating\n a duplicate resource.

\n

\n Related operations:\n

\n " + } + }, + "com.amazonaws.sfn#CreateStateMachineAliasInput": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.sfn#AliasDescription", + "traits": { + "smithy.api#documentation": "

A description for the state machine alias.

" + } + }, + "name": { + "target": "com.amazonaws.sfn#CharacterRestrictedName", + "traits": { + "smithy.api#documentation": "

The name of the state machine alias.

\n

To avoid conflict with version ARNs, don't use an integer in the name of the alias.

", + "smithy.api#required": {} + } + }, + "routingConfiguration": { + "target": "com.amazonaws.sfn#RoutingConfigurationList", + "traits": { + "smithy.api#documentation": "

The routing configuration of a state machine alias. The routing configuration shifts\n execution traffic between two state machine versions. routingConfiguration\n contains an array of RoutingConfig objects that specify up to two state machine\n versions. Step Functions then randomly choses which version to run an execution with based\n on the weight assigned to each RoutingConfig.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#CreateStateMachineAliasOutput": { + "type": "structure", + "members": { + "stateMachineAliasArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the created state machine alias.

", + "smithy.api#required": {} + } + }, + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the state machine alias was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sfn#CreateStateMachineInput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -1617,7 +1771,7 @@ "tags": { "target": "com.amazonaws.sfn#TagList", "traits": { - "smithy.api#documentation": "

Tags to be added when creating a state machine.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

Tags to be added when creating a state machine.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" } }, "tracingConfiguration": { @@ -1625,7 +1779,23 @@ "traits": { "smithy.api#documentation": "

Selects whether X-Ray tracing is enabled.

" } + }, + "publish": { + "target": "com.amazonaws.sfn#Publish", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to publish the first version of the state machine during creation. The default is false.

" + } + }, + "versionDescription": { + "target": "com.amazonaws.sfn#VersionDescription", + "traits": { + "smithy.api#documentation": "

Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#CreateStateMachineOutput": { @@ -1644,7 +1814,16 @@ "smithy.api#documentation": "

The date the state machine is created.

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

The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#Definition": { @@ -1684,11 +1863,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DeleteActivityOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#DeleteStateMachine": { "type": "operation", @@ -1707,7 +1892,55 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a state machine. This is an asynchronous operation: It sets the state machine's\n status to DELETING and begins the deletion process.

\n \n

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

For EXPRESS state machines, the deletion will happen eventually (usually\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

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

Deletes a state machine. This is an asynchronous operation: It sets the state machine's\n status to DELETING and begins the deletion process.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

This API action also deletes all versions and aliases associated with a state machine.

\n \n

For EXPRESS state machines, the deletion happens eventually (usually in\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

\n " + } + }, + "com.amazonaws.sfn#DeleteStateMachineAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#DeleteStateMachineAliasInput" + }, + "output": { + "target": "com.amazonaws.sfn#DeleteStateMachineAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a state machine alias.

\n

After you delete a state machine alias, you can't use it to start executions. When you\n delete a state machine alias, Step Functions doesn't delete the state machine versions\n that alias references.

\n

\n Related operations:\n

\n " + } + }, + "com.amazonaws.sfn#DeleteStateMachineAliasInput": { + "type": "structure", + "members": { + "stateMachineAliasArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine alias to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#DeleteStateMachineAliasOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#DeleteStateMachineInput": { @@ -1720,11 +1953,62 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DeleteStateMachineOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sfn#DeleteStateMachineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#DeleteStateMachineVersionInput" + }, + "output": { + "target": "com.amazonaws.sfn#DeleteStateMachineVersionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a state machine version. After\n you delete a version, you can't call StartExecution using that version's ARN\n or use\n the\n version with a state machine alias.

\n \n

Deleting a state machine version won't terminate its in-progress executions.

\n \n \n

You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

\n \n

\n Related operations:\n

\n " + } + }, + "com.amazonaws.sfn#DeleteStateMachineVersionInput": { + "type": "structure", + "members": { + "stateMachineVersionArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine version to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#DeleteStateMachineVersionOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#DescribeActivity": { "type": "operation", @@ -1743,7 +2027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes an activity.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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

Describes an activity.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n " } }, "com.amazonaws.sfn#DescribeActivityInput": { @@ -1756,6 +2040,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DescribeActivityOutput": { @@ -1771,7 +2058,7 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the activity.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the activity.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -1782,6 +2069,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#DescribeExecution": { @@ -1801,7 +2091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.

" + "smithy.api#documentation": "

Provides information about a state machine execution, such as the state machine\n associated with the execution, the execution input and output, and relevant execution\n metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was\n dispatched by a Map Run.

\n

If you specify a version or alias ARN when you call the StartExecution\n API action, DescribeExecution returns that ARN.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.

" } }, "com.amazonaws.sfn#DescribeExecutionInput": { @@ -1814,6 +2104,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DescribeExecutionOutput": { @@ -1836,7 +2129,7 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the execution.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" + "smithy.api#documentation": "

The name of the execution.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" } }, "status": { @@ -1856,7 +2149,7 @@ "stopDate": { "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

If the execution has already ended, the date the execution stopped.

" + "smithy.api#documentation": "

If the execution ended, the date the execution stopped.

" } }, "input": { @@ -1900,7 +2193,22 @@ "traits": { "smithy.api#documentation": "

The cause string if the state machine execution failed.

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

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

\n

If you start an execution from a StartExecution request without specifying a\n state machine version or alias ARN, Step Functions returns a null value.

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

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

\n

If you start an execution from a StartExecution request with a\n state machine version ARN, this field will be null.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#DescribeMapRun": { @@ -1933,6 +2241,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DescribeMapRunOutput": { @@ -2010,6 +2321,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#DescribeStateMachine": { @@ -2029,69 +2343,154 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

This API action returns the details for a state machine version if the\n stateMachineArn you specify is a state machine version ARN.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n " } }, - "com.amazonaws.sfn#DescribeStateMachineForExecution": { + "com.amazonaws.sfn#DescribeStateMachineAlias": { "type": "operation", "input": { - "target": "com.amazonaws.sfn#DescribeStateMachineForExecutionInput" + "target": "com.amazonaws.sfn#DescribeStateMachineAliasInput" }, "output": { - "target": "com.amazonaws.sfn#DescribeStateMachineForExecutionOutput" + "target": "com.amazonaws.sfn#DescribeStateMachineAliasOutput" }, "errors": [ { - "target": "com.amazonaws.sfn#ExecutionDoesNotExist" + "target": "com.amazonaws.sfn#InvalidArn" }, { - "target": "com.amazonaws.sfn#InvalidArn" + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

" + "smithy.api#documentation": "

Returns details about a state machine alias.

\n

\n Related operations:\n

\n " } }, - "com.amazonaws.sfn#DescribeStateMachineForExecutionInput": { + "com.amazonaws.sfn#DescribeStateMachineAliasInput": { "type": "structure", "members": { - "executionArn": { + "stateMachineAliasArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution you want state machine information for.

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

The Amazon Resource Name (ARN) of the state machine alias.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.sfn#DescribeStateMachineForExecutionOutput": { + "com.amazonaws.sfn#DescribeStateMachineAliasOutput": { "type": "structure", "members": { - "stateMachineArn": { + "stateMachineAliasArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine associated with the execution.

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

The Amazon Resource Name (ARN) of the state machine alias.

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

The name of the state machine associated with the execution.

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

The name of the state machine alias.

" } }, - "definition": { - "target": "com.amazonaws.sfn#Definition", + "description": { + "target": "com.amazonaws.sfn#AliasDescription", "traits": { - "smithy.api#documentation": "

The Amazon States Language definition of the state machine. See Amazon States Language.

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

A description of the alias.

" } }, - "roleArn": { - "target": "com.amazonaws.sfn#Arn", + "routingConfiguration": { + "target": "com.amazonaws.sfn#RoutingConfigurationList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

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

The routing configuration of the alias.

" + } + }, + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the state machine alias was created.

" + } + }, + "updateDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the state machine alias was last updated.

\n

For a newly created state machine, this is the same as the creation date.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sfn#DescribeStateMachineForExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#DescribeStateMachineForExecutionInput" + }, + "output": { + "target": "com.amazonaws.sfn#DescribeStateMachineForExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ExecutionDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about a state machine's definition, its execution role ARN, and\n configuration. If a Map Run dispatched the execution, this action returns the Map Run\n Amazon Resource Name (ARN) in the response.\n The\n state machine returned is the state machine associated with the\n Map Run.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

" + } + }, + "com.amazonaws.sfn#DescribeStateMachineForExecutionInput": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution you want state machine information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#DescribeStateMachineForExecutionOutput": { + "type": "structure", + "members": { + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine associated with the execution.

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

The name of the state machine associated with the execution.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.sfn#Definition", + "traits": { + "smithy.api#documentation": "

The Amazon States Language definition of the state machine. See Amazon States Language.

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

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

", "smithy.api#required": {} } }, @@ -2122,7 +2521,16 @@ "traits": { "smithy.api#documentation": "

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

" } + }, + "revisionId": { + "target": "com.amazonaws.sfn#RevisionId", + "traits": { + "smithy.api#documentation": "

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

\n

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#DescribeStateMachineInput": { @@ -2131,10 +2539,13 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine to describe.

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

The Amazon Resource Name (ARN) of the state machine for which you want the information.

\n

If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#DescribeStateMachineOutput": { @@ -2143,14 +2554,14 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the state machine.

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

The Amazon Resource Name (ARN) that identifies the state machine.

\n

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -2184,7 +2595,7 @@ "creationDate": { "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

The date the state machine is created.

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

The date the state machine is created.

\n

For a state machine version, creationDate is the date the version was created.

", "smithy.api#required": {} } }, @@ -2202,7 +2613,22 @@ "traits": { "smithy.api#documentation": "

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

" } + }, + "revisionId": { + "target": "com.amazonaws.sfn#RevisionId", + "traits": { + "smithy.api#documentation": "

The revision identifier for the state machine.

\n

Use the revisionId parameter to compare between versions of a state machine\n configuration used for executions without performing a diff of the properties, such as\n definition and roleArn.

" + } + }, + "description": { + "target": "com.amazonaws.sfn#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the state machine version.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#Enabled": { @@ -2315,14 +2741,14 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the executed state machine.

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

The Amazon Resource Name (ARN) of the state machine that ran the execution.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the execution.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the execution.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -2358,6 +2784,18 @@ "smithy.api#default": null, "smithy.api#documentation": "

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

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

The Amazon Resource Name (ARN) of the state machine version associated with the execution.

\n

If the state machine execution was started with an unqualified ARN, it returns null.

\n

If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

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

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

\n

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

" + } } }, "traits": { @@ -2384,6 +2822,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.

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

The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.

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

The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.

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

Used by workers to retrieve a task (with the specified activity ARN) which has been\n scheduled for execution by a running state machine. This initiates a long poll, where the\n service holds the HTTP connection open and responds as soon as a task becomes available (i.e.\n an execution of a task of this type is needed.) The maximum time the service holds on to the\n request before responding is 60 seconds. If no task is available within 60 seconds, the poll\n returns a taskToken with a null string.

\n \n \n

This API action isn't logged in CloudTrail.

\n \n \n \n

Workers should set their client side socket timeout to at least 65 seconds (5 seconds\n higher than the maximum time the service may hold the poll request).

\n

Polling with GetActivityTask can cause latency in some implementations. See\n Avoid\n Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

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

Used by workers to retrieve a task (with the specified activity ARN) which has been\n scheduled for execution by a running state machine. This initiates a long poll, where the\n service holds the HTTP connection open and responds as soon as a task becomes available (i.e.\n an execution of a task of this type is needed.) The maximum time the service holds on to the\n request before responding is 60 seconds. If no task is available within 60 seconds, the poll\n returns a taskToken with a null string.

\n \n

This API action isn't logged in CloudTrail.

\n \n \n

Workers should set their client side socket timeout to at least 65 seconds (5 seconds\n higher than the maximum time the service may hold the poll request).

\n

Polling with GetActivityTask can cause latency in some implementations. See\n Avoid\n Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

\n " } }, "com.amazonaws.sfn#GetActivityTaskInput": { @@ -2504,6 +2954,9 @@ "smithy.api#documentation": "

You can provide an arbitrary name in order to identify the worker that the task is\n assigned to. This name is used when it is logged in the execution history.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#GetActivityTaskOutput": { @@ -2521,6 +2974,9 @@ "smithy.api#documentation": "

The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#GetExecutionHistory": { @@ -2543,7 +2999,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the history of the specified execution as a list of events. By default, the\n results are returned in ascending order of the timeStamp of the events. Use the\n reverseOrder parameter to get the latest events first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n

This API action is not supported by EXPRESS state machines.

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

Returns the history of the specified execution as a list of events. By default, the\n results are returned in ascending order of the timeStamp of the events. Use the\n reverseOrder parameter to get the latest events first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n

This API action is not supported by EXPRESS state machines.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2566,7 +3022,7 @@ "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } }, "reverseOrder": { @@ -2588,6 +3044,9 @@ "smithy.api#documentation": "

You can select whether execution data (input or output of a history event) is returned.\n The default is true.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#GetExecutionHistoryOutput": { @@ -2606,6 +3065,9 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#HistoryEvent": { @@ -3452,7 +3914,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the existing activities.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

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

Lists the existing activities.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3468,7 +3930,7 @@ "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } }, "nextToken": { @@ -3477,6 +3939,9 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#ListActivitiesOutput": { @@ -3495,6 +3960,9 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#ListExecutions": { @@ -3526,7 +3994,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

\n

Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

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

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

\n

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

\n

Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3541,7 +4009,7 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

\n

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

" } }, "statusFilter": { @@ -3554,7 +4022,7 @@ "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } }, "nextToken": { @@ -3569,6 +4037,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#ListExecutionsOutput": { @@ -3587,6 +4058,9 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#ListExecutionsPageToken": { @@ -3641,7 +4115,7 @@ "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } }, "nextToken": { @@ -3650,6 +4124,9 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#ListMapRunsOutput": { @@ -3668,39 +4145,48 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.sfn#ListStateMachines": { + "com.amazonaws.sfn#ListStateMachineAliases": { "type": "operation", "input": { - "target": "com.amazonaws.sfn#ListStateMachinesInput" + "target": "com.amazonaws.sfn#ListStateMachineAliasesInput" }, "output": { - "target": "com.amazonaws.sfn#ListStateMachinesOutput" + "target": "com.amazonaws.sfn#ListStateMachineAliasesOutput" }, "errors": [ + { + "target": "com.amazonaws.sfn#InvalidArn" + }, { "target": "com.amazonaws.sfn#InvalidToken" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#StateMachineDeleting" + }, + { + "target": "com.amazonaws.sfn#StateMachineDoesNotExist" } ], "traits": { - "smithy.api#documentation": "

Lists the existing state machines.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "stateMachines", - "pageSize": "maxResults" - } + "smithy.api#documentation": "

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

\n

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n

\n Related operations:\n

\n " } }, - "com.amazonaws.sfn#ListStateMachinesInput": { + "com.amazonaws.sfn#ListStateMachineAliasesInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.sfn#PageSize", + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

\n

If you specify a state machine version ARN, this API returns a list of aliases for that version.

", + "smithy.api#required": {} } }, "nextToken": { @@ -3708,15 +4194,26 @@ "traits": { "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } + }, + "maxResults": { + "target": "com.amazonaws.sfn#PageSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.sfn#ListStateMachinesOutput": { + "com.amazonaws.sfn#ListStateMachineAliasesOutput": { "type": "structure", "members": { - "stateMachines": { - "target": "com.amazonaws.sfn#StateMachineList", + "stateMachineAliases": { + "target": "com.amazonaws.sfn#StateMachineAliasList", "traits": { + "smithy.api#documentation": "

Aliases for the state machine.

", "smithy.api#required": {} } }, @@ -3726,82 +4223,227 @@ "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.sfn#ListTagsForResource": { + "com.amazonaws.sfn#ListStateMachineVersions": { "type": "operation", "input": { - "target": "com.amazonaws.sfn#ListTagsForResourceInput" + "target": "com.amazonaws.sfn#ListStateMachineVersionsInput" }, "output": { - "target": "com.amazonaws.sfn#ListTagsForResourceOutput" + "target": "com.amazonaws.sfn#ListStateMachineVersionsOutput" }, "errors": [ { "target": "com.amazonaws.sfn#InvalidArn" }, { - "target": "com.amazonaws.sfn#ResourceNotFound" + "target": "com.amazonaws.sfn#InvalidToken" + }, + { + "target": "com.amazonaws.sfn#ValidationException" } ], "traits": { - "smithy.api#documentation": "

List tags for a given resource.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

Lists versions for the specified state machine Amazon Resource Name (ARN).

\n

The results are sorted in descending order of the version creation time.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n

\n Related operations:\n

\n " } }, - "com.amazonaws.sfn#ListTagsForResourceInput": { + "com.amazonaws.sfn#ListStateMachineVersionsInput": { "type": "structure", "members": { - "resourceArn": { + "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

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

The Amazon Resource Name (ARN) of the state machine.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.sfn#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.sfn#TagList", + }, + "nextToken": { + "target": "com.amazonaws.sfn#PageToken", "traits": { - "smithy.api#documentation": "

An array of tags associated with the resource.

" + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" + } + }, + "maxResults": { + "target": "com.amazonaws.sfn#PageSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.sfn#LogDestination": { + "com.amazonaws.sfn#ListStateMachineVersionsOutput": { "type": "structure", "members": { - "cloudWatchLogsLogGroup": { - "target": "com.amazonaws.sfn#CloudWatchLogsLogGroup", + "stateMachineVersions": { + "target": "com.amazonaws.sfn#StateMachineVersionList", "traits": { - "smithy.api#documentation": "

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Versions for the state machine.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

" + "smithy.api#output": {} } }, - "com.amazonaws.sfn#LogDestinationList": { - "type": "list", - "member": { - "target": "com.amazonaws.sfn#LogDestination" + "com.amazonaws.sfn#ListStateMachines": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#ListStateMachinesInput" + }, + "output": { + "target": "com.amazonaws.sfn#ListStateMachinesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#InvalidToken" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the existing state machines.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "stateMachines", + "pageSize": "maxResults" + } } }, - "com.amazonaws.sfn#LogLevel": { - "type": "enum", + "com.amazonaws.sfn#ListStateMachinesInput": { + "type": "structure", "members": { - "ALL": { - "target": "smithy.api#Unit", + "maxResults": { + "target": "com.amazonaws.sfn#PageSize", "traits": { - "smithy.api#enumValue": "ALL" + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

\n

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

" } }, - "ERROR": { - "target": "smithy.api#Unit", + "nextToken": { + "target": "com.amazonaws.sfn#PageToken", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#ListStateMachinesOutput": { + "type": "structure", + "members": { + "stateMachines": { + "target": "com.amazonaws.sfn#StateMachineList", + "traits": { + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.sfn#PageToken", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sfn#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.sfn#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

List tags for a given resource.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + } + }, + "com.amazonaws.sfn#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.sfn#TagList", + "traits": { + "smithy.api#documentation": "

An array of tags associated with the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sfn#LogDestination": { + "type": "structure", + "members": { + "cloudWatchLogsLogGroup": { + "target": "com.amazonaws.sfn#CloudWatchLogsLogGroup", + "traits": { + "smithy.api#documentation": "

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

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

" + } + }, + "com.amazonaws.sfn#LogDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#LogDestination" + } + }, + "com.amazonaws.sfn#LogLevel": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "ERROR": { + "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } @@ -4199,6 +4841,94 @@ } } }, + "com.amazonaws.sfn#Publish": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sfn#PublishStateMachineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#PublishStateMachineVersionInput" + }, + "output": { + "target": "com.amazonaws.sfn#PublishStateMachineVersionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.sfn#StateMachineDeleting" + }, + { + "target": "com.amazonaws.sfn#StateMachineDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a version from the\n current revision of a state machine. Use versions to create immutable snapshots of your state\n machine. You can start executions from versions either directly or with an alias. To create an\n alias, use CreateStateMachineAlias.

\n

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

\n

\n PublishStateMachineVersion is an idempotent API. It doesn't create a\n duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the\n stateMachineArn, name, and revisionId parameters.\n Requests with the same parameters return a successful idempotent response. If you don't\n specify a revisionId, Step Functions checks for a previously published\n version of the state machine's current revision.

\n

\n Related operations:\n

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.sfn#PublishStateMachineVersionInput": { + "type": "structure", + "members": { + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine.

", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.sfn#RevisionId", + "traits": { + "smithy.api#documentation": "

Only publish the state machine version if the current state machine's revision ID matches the specified ID.

\n

Use this option to avoid publishing a version if the state machine changed since you last\n updated it. If the specified revision ID doesn't match the state machine's current revision\n ID, the API returns ConflictException.

\n \n

To specify an initial revision ID for a state machine with no revision ID assigned,\n specify the string INITIAL for the revisionId parameter. For\n example, you can specify a revisionID of INITIAL when you create a\n state machine using the CreateStateMachine API action.

\n " + } + }, + "description": { + "target": "com.amazonaws.sfn#VersionDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the state machine version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#PublishStateMachineVersionOutput": { + "type": "structure", + "members": { + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the version was created.

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

The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sfn#ResourceNotFound": { "type": "structure", "members": { @@ -4210,7 +4940,7 @@ } }, "traits": { - "smithy.api#documentation": "

Could not find the referenced resource. Only state machine and activity ARNs are\n supported.

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

Could not find the referenced resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4221,6 +4951,44 @@ "smithy.api#default": false } }, + "com.amazonaws.sfn#RevisionId": { + "type": "string" + }, + "com.amazonaws.sfn#RoutingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#RoutingConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.sfn#RoutingConfigurationListItem": { + "type": "structure", + "members": { + "stateMachineVersionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.

\n

If you specify the ARN of a second version, it must belong to the same state machine as the first version.

", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.sfn#VersionWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of traffic you want to route to the second state machine\n version. The sum of the weights in the routing\n configuration must be equal to 100.

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

Contains details about the routing configuration of a state machine alias. In a routing\n configuration, you define an array of objects that specify up to two state machine versions.\n You also specify the percentage of traffic to be routed to each version.

" + } + }, "com.amazonaws.sfn#SendTaskFailure": { "type": "operation", "input": { @@ -4266,11 +5034,17 @@ "smithy.api#documentation": "

A more detailed explanation of the cause of the failure.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#SendTaskFailureOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#SendTaskHeartbeat": { "type": "operation", @@ -4305,11 +5079,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#SendTaskHeartbeatOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#SendTaskSuccess": { "type": "operation", @@ -4354,11 +5134,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#SendTaskSuccessOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#SensitiveCause": { "type": "string", @@ -4400,6 +5186,19 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.sfn#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request would cause a service quota to be exceeded.

\n

HTTP Status Code: 402

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.sfn#StartExecution": { "type": "operation", "input": { @@ -4435,7 +5234,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

\n StartExecution is idempotent for STANDARD workflows. For a\n STANDARD workflow, if StartExecution is called with the same\n name and input as a running execution, the call will succeed and return the same response as\n the original request. If the execution is closed or if the input is different, it will\n return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

\n

\n StartExecution is not idempotent for EXPRESS workflows.

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

Starts a state machine execution.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

\n

To start executions of a state machine version, call\n StartExecution and provide the version ARN or the ARN of an alias that points to the version.

\n \n

\n StartExecution is idempotent for STANDARD workflows. For a\n STANDARD workflow, if you call StartExecution with the same name\n and input as a running execution, the call succeeds and return the same response as the\n original request. If the execution is closed or if the input is different, it returns a\n 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

\n

\n StartExecution isn't idempotent for EXPRESS workflows.

\n ", "smithy.api#idempotent": {} } }, @@ -4445,14 +5244,14 @@ "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine to execute.

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

The Amazon Resource Name (ARN) of the state machine to execute.

\n

The stateMachineArn parameter accepts one of the following inputs:

\n ", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" + "smithy.api#documentation": "

Optional name of the execution.\n This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" } }, "input": { @@ -4467,6 +5266,9 @@ "smithy.api#documentation": "

Passes the X-Ray trace header. The trace header can also be passed in the request\n payload.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#StartExecutionOutput": { @@ -4486,6 +5288,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#StartSyncExecution": { @@ -4551,6 +5356,9 @@ "smithy.api#documentation": "

Passes the X-Ray trace header. The trace header can also be passed in the request\n payload.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#StartSyncExecutionOutput": { @@ -4638,6 +5446,9 @@ "smithy.api#documentation": "

An object that describes workflow billing details, including billed duration and memory\n use.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#StateEnteredEventDetails": { @@ -4694,6 +5505,34 @@ "smithy.api#documentation": "

Contains details about an exit from a state during an execution.

" } }, + "com.amazonaws.sfn#StateMachineAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#StateMachineAliasListItem" + } + }, + "com.amazonaws.sfn#StateMachineAliasListItem": { + "type": "structure", + "members": { + "stateMachineAliasArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

", + "smithy.api#required": {} + } + }, + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date of a state machine alias.

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

Contains details about a specific state machine alias.

" + } + }, "com.amazonaws.sfn#StateMachineAlreadyExists": { "type": "structure", "members": { @@ -4761,7 +5600,7 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

The name of the state machine.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

", "smithy.api#required": {} } }, @@ -4830,6 +5669,34 @@ "smithy.api#error": "client" } }, + "com.amazonaws.sfn#StateMachineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#StateMachineVersionListItem" + } + }, + "com.amazonaws.sfn#StateMachineVersionListItem": { + "type": "structure", + "members": { + "stateMachineVersionArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

", + "smithy.api#required": {} + } + }, + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date of a state machine version.

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

Contains details about a specific state machine version.

" + } + }, "com.amazonaws.sfn#StopExecution": { "type": "operation", "input": { @@ -4850,7 +5717,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an execution.

\n

This API action is not supported by EXPRESS state machines.

" + "smithy.api#documentation": "

Stops an execution.

\n

This API action is not supported by EXPRESS state machines.

" } }, "com.amazonaws.sfn#StopExecutionInput": { @@ -4875,6 +5742,9 @@ "smithy.api#documentation": "

A more detailed explanation of the cause of the failure.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#StopExecutionOutput": { @@ -4887,6 +5757,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#SyncExecutionStatus": { @@ -4929,7 +5802,7 @@ } }, "traits": { - "smithy.api#documentation": "

Tags are key-value pairs that can be associated with Step Functions state machines and\n activities.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

Tags are key-value pairs that can be associated with Step Functions state machines and\n activities.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" } }, "com.amazonaws.sfn#TagKey": { @@ -4973,7 +5846,7 @@ } ], "traits": { - "smithy.api#documentation": "

Add a tag to a Step Functions resource.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" + "smithy.api#documentation": "

Add a tag to a Step Functions resource.

\n

An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

" } }, "com.amazonaws.sfn#TagResourceInput": { @@ -4989,15 +5862,21 @@ "tags": { "target": "com.amazonaws.sfn#TagList", "traits": { - "smithy.api#documentation": "

The list of tags to add to a resource.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

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

The list of tags to add to a resource.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#TagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#TagValue": { "type": "string", @@ -5459,11 +6338,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#UntagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#UpdateMapRun": { "type": "operation", @@ -5519,11 +6404,17 @@ "smithy.api#documentation": "

The maximum number of failed items before the Map Run fails.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#UpdateMapRunOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.sfn#UpdateStateMachine": { "type": "operation", @@ -5534,6 +6425,9 @@ "target": "com.amazonaws.sfn#UpdateStateMachineOutput" }, "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, { "target": "com.amazonaws.sfn#InvalidArn" }, @@ -5549,6 +6443,9 @@ { "target": "com.amazonaws.sfn#MissingRequiredParameter" }, + { + "target": "com.amazonaws.sfn#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.sfn#StateMachineDeleting" }, @@ -5560,10 +6457,78 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing state machine by modifying its definition,\n roleArn, or loggingConfiguration. Running executions will continue\n to use the previous definition and roleArn. You must include at\n least one of definition or roleArn or you will receive a\n MissingRequiredParameter error.

\n \n

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

\n \n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n \n \n

All StartExecution calls within a few seconds will use the updated\n definition and roleArn. Executions started immediately after\n calling UpdateStateMachine may use the previous state machine\n definition and roleArn.

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

Updates an existing state machine by modifying its definition,\n roleArn, or loggingConfiguration. Running executions will continue\n to use the previous definition and roleArn. You must include at\n least one of definition or roleArn or you will receive a\n MissingRequiredParameter error.

\n

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

After you update your state machine, you can set the publish parameter to\n true in the same action to publish a new version. This\n way, you can opt-in to strict versioning of your state machine.

\n \n

Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

\n \n \n

All StartExecution calls within a few seconds use the updated\n definition and roleArn. Executions started immediately after you\n call UpdateStateMachine may use the previous state machine\n definition and roleArn.

\n ", "smithy.api#idempotent": {} } }, + "com.amazonaws.sfn#UpdateStateMachineAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#UpdateStateMachineAliasInput" + }, + "output": { + "target": "com.amazonaws.sfn#UpdateStateMachineAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ConflictException" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + }, + { + "target": "com.amazonaws.sfn#ResourceNotFound" + }, + { + "target": "com.amazonaws.sfn#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

\n

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

\n \n

\n UpdateStateMachineAlias is an idempotent API. Step Functions bases the\n idempotency check on the stateMachineAliasArn, description, and\n routingConfiguration parameters. Requests with the same parameters return an\n idempotent response.

\n \n \n

This operation is eventually consistent. All StartExecution requests\n made within a few seconds use the latest alias configuration. Executions started immediately\n after calling UpdateStateMachineAlias may use the previous routing\n configuration.

\n \n

\n Related operations:\n

\n " + } + }, + "com.amazonaws.sfn#UpdateStateMachineAliasInput": { + "type": "structure", + "members": { + "stateMachineAliasArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine alias.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.sfn#AliasDescription", + "traits": { + "smithy.api#documentation": "

A description of the state machine alias.

" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.sfn#RoutingConfigurationList", + "traits": { + "smithy.api#documentation": "

The routing configuration of the state machine alias.

\n

An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#UpdateStateMachineAliasOutput": { + "type": "structure", + "members": { + "updateDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the state machine alias was updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sfn#UpdateStateMachineInput": { "type": "structure", "members": { @@ -5589,7 +6554,7 @@ "loggingConfiguration": { "target": "com.amazonaws.sfn#LoggingConfiguration", "traits": { - "smithy.api#documentation": "

The LoggingConfiguration data type is used to set CloudWatch Logs\n options.

" + "smithy.api#documentation": "

Use the LoggingConfiguration data type to set CloudWatch Logs\n options.

" } }, "tracingConfiguration": { @@ -5597,7 +6562,23 @@ "traits": { "smithy.api#documentation": "

Selects whether X-Ray tracing is enabled.

" } + }, + "publish": { + "target": "com.amazonaws.sfn#Publish", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the state machine version is published. The default is\n false. To publish a version after updating the state machine, set\n publish to true.

" + } + }, + "versionDescription": { + "target": "com.amazonaws.sfn#VersionDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the state machine version to publish.

\n

You can only specify the versionDescription parameter if you've set publish to true.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.sfn#UpdateStateMachineOutput": { @@ -5609,7 +6590,22 @@ "smithy.api#documentation": "

The date and time the state machine was updated.

", "smithy.api#required": {} } + }, + "revisionId": { + "target": "com.amazonaws.sfn#RevisionId", + "traits": { + "smithy.api#documentation": "

The revision identifier for the updated state machine.

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

The Amazon Resource Name (ARN) of the published state machine version.

\n

If the publish parameter isn't set to true, this field returns null.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.sfn#ValidationException": { @@ -5651,6 +6647,32 @@ "traits": { "smithy.api#enumValue": "CANNOT_UPDATE_COMPLETED_MAP_RUN" } + }, + "INVALID_ROUTING_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ROUTING_CONFIGURATION" + } + } + } + }, + "com.amazonaws.sfn#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sfn#VersionWeight": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 } } }, diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index 717b21763a3..9528457e18a 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -240,7 +240,7 @@ "ResourceId": { "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

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

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource. If you're tagging a shared document, you must use the full ARN of the document.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

\n ", "smithy.api#required": {} } }, @@ -258,7 +258,10 @@ }, "com.amazonaws.ssm#AddTagsToResourceResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#AgentErrorCode": { "type": "string", @@ -824,7 +827,7 @@ "name": "ssm" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

\n

\n Related resources\n

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

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

\n

\n Related resources\n

\n ", "smithy.api#title": "Amazon Simple Systems Manager (SSM)", "smithy.api#xmlNamespace": { "uri": "http://ssm.amazonaws.com/doc/2014-11-06/" @@ -4295,7 +4298,8 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Whether or not the command was successfully canceled. There is no guarantee that a request\n can be canceled.

" + "smithy.api#documentation": "

Whether or not the command was successfully canceled. There is no guarantee that a request\n can be canceled.

", + "smithy.api#output": {} } }, "com.amazonaws.ssm#CancelMaintenanceWindowExecution": { @@ -4342,6 +4346,9 @@ "smithy.api#documentation": "

The ID of the maintenance window execution that has been stopped.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#Category": { @@ -5699,6 +5706,9 @@ "smithy.api#documentation": "

The code the system generates when it processes the activation. The activation code\n functions like a password to validate the activation ID.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateAssociation": { @@ -5970,6 +5980,9 @@ "smithy.api#documentation": "

Information about the associations that failed.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateAssociationRequest": { @@ -6109,6 +6122,9 @@ "smithy.api#documentation": "

Information about the association.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateDocument": { @@ -6222,6 +6238,9 @@ "smithy.api#documentation": "

Information about the SSM document.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateMaintenanceWindow": { @@ -6346,6 +6365,9 @@ "smithy.api#documentation": "

The ID of the created maintenance window.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateOpsItem": { @@ -6374,7 +6396,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with\n OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see Amazon Web Services Systems Manager OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see Amazon Web Services Systems Manager OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" } }, "com.amazonaws.ssm#CreateOpsItemRequest": { @@ -6396,7 +6418,7 @@ "OperationalData": { "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems\n manually in the Amazon Web Services Systems Manager User Guide.

" } }, "Notifications": { @@ -6434,7 +6456,7 @@ "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can restrict access to OpsItems by\n using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Tags use a key-value pair. For example:

\n

\n Key=Department,Value=Finance\n

\n \n

To add tags to a new OpsItem, a user must have IAM permissions for both the\n ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation.\n To add tags to an existing OpsItem, use the AddTagsToResource\n operation.

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

Optional metadata that you assign to a resource.

\n

Tags use a key-value pair. For example:

\n

\n Key=Department,Value=Finance\n

\n \n

To add tags to a new OpsItem, a user must have IAM permissions for both the\n ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation.\n To add tags to an existing OpsItem, use the AddTagsToResource\n operation.

\n " } }, "Category": { @@ -6476,7 +6498,7 @@ "AccountId": { "target": "com.amazonaws.ssm#OpsItemAccountId", "traits": { - "smithy.api#documentation": "

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account\n must be configured to work with OpsItems across accounts. For more information, see Setting\n up OpsCenter to work with OpsItems across accounts in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account\n must be configured to work with OpsItems across accounts. For more information, see Set up\n OpsCenter in the Amazon Web Services Systems Manager User Guide.

" } } }, @@ -6569,6 +6591,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreatePatchBaseline": { @@ -6692,6 +6717,9 @@ "smithy.api#documentation": "

The ID of the created patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#CreateResourceDataSync": { @@ -6755,7 +6783,10 @@ }, "com.amazonaws.ssm#CreateResourceDataSyncResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#CreatedDate": { "type": "timestamp" @@ -6838,7 +6869,10 @@ }, "com.amazonaws.ssm#DeleteActivationResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteAssociation": { "type": "operation", @@ -6897,7 +6931,10 @@ }, "com.amazonaws.ssm#DeleteAssociationResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteDocument": { "type": "operation", @@ -6961,7 +6998,10 @@ }, "com.amazonaws.ssm#DeleteDocumentResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteInventory": { "type": "operation", @@ -7048,6 +7088,9 @@ "smithy.api#documentation": "

A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeleteMaintenanceWindow": { @@ -7091,6 +7134,9 @@ "smithy.api#documentation": "

The ID of the deleted maintenance window.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeleteOpsMetadata": { @@ -7133,7 +7179,10 @@ }, "com.amazonaws.ssm#DeleteOpsMetadataResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteParameter": { "type": "operation", @@ -7172,7 +7221,10 @@ }, "com.amazonaws.ssm#DeleteParameterResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteParameters": { "type": "operation", @@ -7221,6 +7273,9 @@ "smithy.api#documentation": "

The names of parameters that weren't deleted because the parameters aren't valid.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeletePatchBaseline": { @@ -7267,6 +7322,9 @@ "smithy.api#documentation": "

The ID of the deleted patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeleteResourceDataSync": { @@ -7315,7 +7373,10 @@ }, "com.amazonaws.ssm#DeleteResourceDataSyncResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeleteResourcePolicy": { "type": "operation", @@ -7419,7 +7480,10 @@ }, "com.amazonaws.ssm#DeregisterManagedInstanceResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#DeregisterPatchBaselineForPatchGroup": { "type": "operation", @@ -7478,6 +7542,9 @@ "smithy.api#documentation": "

The name of the patch group deregistered from the patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeregisterTargetFromMaintenanceWindow": { @@ -7547,6 +7614,9 @@ "smithy.api#documentation": "

The ID of the removed target definition.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DeregisterTaskFromMaintenanceWindow": { @@ -7606,6 +7676,9 @@ "smithy.api#documentation": "

The ID of the task removed from the maintenance window.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeActivations": { @@ -7728,6 +7801,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAssociation": { @@ -7847,6 +7923,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAssociationExecutions": { @@ -7927,6 +8006,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAssociationRequest": { @@ -7970,6 +8052,9 @@ "smithy.api#documentation": "

Information about the association.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAutomationExecutions": { @@ -8046,6 +8131,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAutomationStepExecutions": { @@ -8139,6 +8227,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeAvailablePatches": { @@ -8206,6 +8297,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeDocument": { @@ -8357,6 +8451,9 @@ "smithy.api#documentation": "

Information about the SSM document.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeEffectiveInstanceAssociations": { @@ -8431,6 +8528,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeEffectivePatchesForPatchBaseline": { @@ -8508,6 +8608,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInstanceAssociationsStatus": { @@ -8582,6 +8685,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInstanceInformation": { @@ -8610,7 +8716,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more of your managed nodes, including information about the operating\n system platform, the version of SSM Agent installed on the managed node, node status, and so\n on.

\n

If you specify one or more managed node IDs, it returns information for those managed nodes.\n If you don't specify node IDs, it returns information for all your managed nodes. If you specify\n a node ID that isn't valid or a node that you don't own, you receive an error.

\n \n

The IamRole field for this API operation is the Identity and Access Management\n (IAM) role assigned to on-premises managed nodes. This call doesn't return the\n IAM role for EC2 instances.

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

Provides information about one or more of your managed nodes, including the operating system\n platform, SSM Agent version, association status, and IP address. This operation does not return\n information for nodes that are either Stopped or Terminated.

\n

If you specify one or more node IDs, the operation returns information for those managed\n nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you\n specify a node ID that isn't valid or a node that you don't own, you receive an error.

\n \n

The IamRole field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not\n return the IAM role for EC2 instances.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8631,14 +8737,14 @@ "Filters": { "target": "com.amazonaws.ssm#InstanceInformationStringFilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Use a filter to return a more specific list of managed nodes. You can\n filter based on tags applied to your managed nodes. Use this Filters data type\n instead of InstanceInformationFilterList, which is deprecated.

" + "smithy.api#documentation": "

One or more filters. Use a filter to return a more specific list of managed nodes. You can\n filter based on tags applied to your managed nodes. Tag filters can't be combined with other\n filter types. Use this Filters data type instead of\n InstanceInformationFilterList, which is deprecated.

" } }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResultsEC2Compatible", "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\n can specify in a subsequent call to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results. The default value is 10 items.\n

" } }, "NextToken": { @@ -8667,6 +8773,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInstancePatchStates": { @@ -8773,6 +8882,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInstancePatchStatesRequest": { @@ -8818,6 +8930,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInstancePatches": { @@ -8901,6 +9016,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeInventoryDeletions": { @@ -8974,6 +9092,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionTaskInvocations": { @@ -9058,6 +9179,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionTasks": { @@ -9135,6 +9259,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutions": { @@ -9209,6 +9336,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowSchedule": { @@ -9297,6 +9427,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You use this token in the next call.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowTargets": { @@ -9374,6 +9507,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowTasks": { @@ -9451,6 +9587,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindows": { @@ -9549,6 +9688,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You use this token in the next call.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeMaintenanceWindowsRequest": { @@ -9593,6 +9735,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeOpsItems": { @@ -9609,7 +9754,7 @@ } ], "traits": { - "smithy.api#documentation": "

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with\n OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

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

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9624,7 +9769,7 @@ "OpsItemFilters": { "target": "com.amazonaws.ssm#OpsItemFilters", "traits": { - "smithy.api#documentation": "

One or more filters to limit the response.

\n \n

*The Equals operator for Title matches the first 100 characters. If you specify more than\n 100 characters, they system returns an error that the filter value exceeds the length\n limit.

\n

**If you filter the response by using the OperationalData operator, specify a key-value pair\n by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}

" + "smithy.api#documentation": "

One or more filters to limit the response.

\n \n

*The Equals operator for Title matches the first 100 characters. If you specify more than\n 100 characters, they system returns an error that the filter value exceeds the length\n limit.

\n

**If you filter the response by using the OperationalData operator, specify a key-value pair\n by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}

" } }, "MaxResults": { @@ -9746,6 +9891,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribePatchBaselines": { @@ -9813,6 +9961,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribePatchGroupState": { @@ -9937,6 +10088,9 @@ "smithy.api#documentation": "

The number of managed nodes with patches installed that are specified as other than\n Critical or Security but aren't compliant with the patch baseline. The\n status of these managed nodes is NON_COMPLIANT.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribePatchGroups": { @@ -10004,6 +10158,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribePatchProperties": { @@ -10085,6 +10242,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You use this token in the next call.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#DescribeSessions": { @@ -11673,6 +11833,9 @@ "smithy.api#documentation": "

Detailed information about the current state of an automation execution.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetCalendarState": { @@ -12004,6 +12167,9 @@ "smithy.api#documentation": "

Amazon CloudWatch Logs information where Systems Manager sent the command output.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetConnectionStatus": { @@ -12104,6 +12270,9 @@ "smithy.api#documentation": "

The operating system for the returned patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetDeployablePatchSnapshotForInstance": { @@ -12184,6 +12353,9 @@ "smithy.api#documentation": "

Returns the specific operating system (for example Windows Server 2012 or Amazon Linux\n 2015.09) on the managed node for the specified patch snapshot.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetDocument": { @@ -12323,6 +12495,9 @@ "smithy.api#documentation": "

The current review status of a new custom Systems Manager document (SSM document) created by a member\n of your organization, or of the latest version of an existing SSM document.

\n

Only one version of an SSM document can be in the APPROVED state at a time. When a new\n version is approved, the status of the previous version changes to REJECTED.

\n

Only one version of an SSM document can be in review, or PENDING, at a time.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetInventory": { @@ -12420,6 +12595,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetInventorySchema": { @@ -12517,6 +12695,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetMaintenanceWindow": { @@ -12613,6 +12794,9 @@ "smithy.api#documentation": "

The time the maintenance window finished running.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetMaintenanceWindowExecutionTask": { @@ -12759,6 +12943,9 @@ "smithy.api#documentation": "

The maintenance window target ID.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetMaintenanceWindowExecutionTaskRequest": { @@ -12877,6 +13064,9 @@ "smithy.api#documentation": "

The CloudWatch alarms that were invoked by the maintenance window task.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetMaintenanceWindowRequest": { @@ -12992,6 +13182,9 @@ "smithy.api#documentation": "

The date the maintenance window was last modified.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetMaintenanceWindowTask": { @@ -13136,6 +13329,9 @@ "smithy.api#documentation": "

The details for the CloudWatch alarm you applied to your maintenance window\n task.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetOpsItem": { @@ -13158,7 +13354,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information,\n see Getting started with\n OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information,\n see Set\n up OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" } }, "com.amazonaws.ssm#GetOpsItemRequest": { @@ -13278,6 +13474,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetOpsSummary": { @@ -13378,6 +13577,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetParameter": { @@ -13487,6 +13689,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetParameterRequest": { @@ -13520,6 +13725,9 @@ "smithy.api#documentation": "

Information about a parameter.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetParameters": { @@ -13652,6 +13860,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetParametersRequest": { @@ -13691,6 +13902,9 @@ "smithy.api#documentation": "

A list of parameters that aren't formatted correctly or don't run during an\n execution.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetPatchBaseline": { @@ -13775,6 +13989,9 @@ "smithy.api#documentation": "

The operating system rule specified for patch groups using the patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetPatchBaselineRequest": { @@ -13886,6 +14103,9 @@ "smithy.api#documentation": "

Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#GetResourcePolicies": { @@ -14040,7 +14260,8 @@ } }, "traits": { - "smithy.api#documentation": "

The query result body of the GetServiceSetting API operation.

" + "smithy.api#documentation": "

The query result body of the GetServiceSetting API operation.

", + "smithy.api#output": {} } }, "com.amazonaws.ssm#HierarchyLevelLimitExceededException": { @@ -14429,7 +14650,7 @@ "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud\n (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use\n the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in\n the Amazon Web Services CLI Command Reference.

" + "smithy.api#documentation": "

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud\n (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use\n the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

" } }, "RegistrationDate": { @@ -14447,7 +14668,7 @@ "Name": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is\n activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName\n property using the CreateActivation command. It is applied to the managed node\n by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a\n hybrid environment (Windows). To retrieve the Name tag of an EC2 instance,\n use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in\n the Amazon Web Services CLI Command Reference.

" + "smithy.api#documentation": "

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is\n activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName\n property using the CreateActivation command. It is applied to the managed node\n by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a\n hybrid environment (Windows). To retrieve the Name tag of an EC2 instance,\n use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

" } }, "IPAddress": { @@ -16587,6 +16808,9 @@ "smithy.api#documentation": "

The version of the parameter that has been labeled.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#LastResourceDataSyncMessage": { @@ -16693,6 +16917,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListAssociations": { @@ -16763,6 +16990,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListCommandInvocations": { @@ -16861,6 +17091,9 @@ "smithy.api#documentation": "

(Optional) The token for the next set of items to return. (You received this token from a\n previous call.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListCommands": { @@ -16952,6 +17185,9 @@ "smithy.api#documentation": "

(Optional) The token for the next set of items to return. (You received this token from a\n previous call.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListComplianceItems": { @@ -17043,6 +17279,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListComplianceSummaries": { @@ -17116,6 +17355,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListDocumentMetadataHistory": { @@ -17295,6 +17537,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListDocuments": { @@ -17374,6 +17619,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListInventoryEntries": { @@ -17485,6 +17733,9 @@ "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListOpsItemEvents": { @@ -17721,6 +17972,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListResourceComplianceSummaries": { @@ -17794,6 +18048,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListResourceDataSync": { @@ -17867,6 +18124,9 @@ "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ListTagsForResource": { @@ -17923,6 +18183,9 @@ "smithy.api#documentation": "

A list of tags.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#LoggingInfo": { @@ -19964,7 +20227,7 @@ "OperationalData": { "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems\n manually in the Amazon Web Services Systems Manager User Guide.

" } }, "Category": { @@ -20585,7 +20848,7 @@ "code": "OpsItemLimitExceededException", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request caused OpsItems to exceed one or more quotas. For information about OpsItem\n quotas, see What are the resource limits for OpsCenter?.

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

The request caused OpsItems to exceed one or more quotas.

", "smithy.api#error": "client" } }, @@ -23505,7 +23768,10 @@ }, "com.amazonaws.ssm#PutComplianceItemsResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#PutInventory": { "type": "operation", @@ -23591,6 +23857,9 @@ "smithy.api#documentation": "

Information about the request.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#PutParameter": { @@ -23721,7 +23990,7 @@ "DataType": { "target": "com.amazonaws.ssm#ParameterDataType", "traits": { - "smithy.api#documentation": "

The data type for a String parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.

\n

\n The following data type values are supported.\n

\n \n

When you create a String parameter and specify aws:ec2:image,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n ami-12345abcdeEXAMPLE, and that the specified AMI is available in your\n Amazon Web Services account.

\n \n

If the action is successful, the service sends back an HTTP 200 response which indicates a\n successful PutParameter call for all cases except for data type\n aws:ec2:image. If you call PutParameter with\n aws:ec2:image data type, a successful HTTP 200 response does not guarantee that\n your parameter was successfully created or updated. The aws:ec2:image value is\n validated asynchronously, and the PutParameter call returns before the validation\n is complete. If you submit an invalid AMI value, the PutParameter operation will return success,\n but the asynchronous validation will fail and the parameter will not be created or updated. To\n monitor whether your aws:ec2:image parameters are created successfully, see Setting\n up notifications or trigger actions based on Parameter Store events. For more\n information about AMI format validation , see Native parameter\n support for Amazon Machine Image (AMI) IDs.

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

The data type for a String parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.

\n

\n The following data type values are supported.\n

\n \n

When you create a String parameter and specify aws:ec2:image,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n ami-12345abcdeEXAMPLE, and that the specified AMI is available in your\n Amazon Web Services account.

\n \n

If the action is successful, the service sends back an HTTP 200 response which indicates a\n successful PutParameter call for all cases except for data type\n aws:ec2:image. If you call PutParameter with\n aws:ec2:image data type, a successful HTTP 200 response does not guarantee that\n your parameter was successfully created or updated. The aws:ec2:image value is\n validated asynchronously, and the PutParameter call returns before the validation\n is complete. If you submit an invalid AMI value, the PutParameter operation will return success,\n but the asynchronous validation will fail and the parameter will not be created or updated. To\n monitor whether your aws:ec2:image parameters are created successfully, see Setting\n up notifications or trigger actions based on Parameter Store events. For more\n information about AMI format validation , see Native parameter\n support for Amazon Machine Image (AMI) IDs.

\n " } } }, @@ -23745,6 +24014,9 @@ "smithy.api#documentation": "

The tier assigned to the parameter.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#PutResourcePolicy": { @@ -23906,6 +24178,9 @@ "smithy.api#documentation": "

The ID of the default patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#RegisterPatchBaselineForPatchGroup": { @@ -23974,6 +24249,9 @@ "smithy.api#documentation": "

The name of the patch group registered with the patch baseline.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#RegisterTargetWithMaintenanceWindow": { @@ -24065,6 +24343,9 @@ "smithy.api#documentation": "

The ID of the target definition in this maintenance window.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#RegisterTaskWithMaintenanceWindow": { @@ -24214,6 +24495,9 @@ "smithy.api#documentation": "

The ID of the task in the maintenance window.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#RegistrationLimit": { @@ -24368,7 +24652,10 @@ }, "com.amazonaws.ssm#RemoveTagsFromResourceResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#RequireType": { "type": "string", @@ -24430,7 +24717,8 @@ } }, "traits": { - "smithy.api#documentation": "

The result body of the ResetServiceSetting API operation.

" + "smithy.api#documentation": "

The result body of the ResetServiceSetting API operation.

", + "smithy.api#output": {} } }, "com.amazonaws.ssm#ResolvedTargets": { @@ -25655,7 +25943,10 @@ }, "com.amazonaws.ssm#SendAutomationSignalResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#SendCommand": { "type": "operation", @@ -25831,6 +26122,9 @@ "smithy.api#documentation": "

The request as it was received by Systems Manager. Also provides the command ID which can be used\n future references to this request.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#ServiceRole": { @@ -26460,7 +26754,10 @@ }, "com.amazonaws.ssm#StartAssociationsOnceResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#StartAutomationExecution": { "type": "operation", @@ -26593,6 +26890,9 @@ "smithy.api#documentation": "

The unique ID of a newly scheduled automation execution.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#StartChangeRequestExecution": { @@ -26716,6 +27016,9 @@ "smithy.api#documentation": "

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation\n operation.)

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#StartSession": { @@ -27140,7 +27443,10 @@ }, "com.amazonaws.ssm#StopAutomationExecutionResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#StopType": { "type": "enum", @@ -27660,6 +27966,9 @@ "smithy.api#documentation": "

The labels that aren't attached to the given parameter version.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UnsupportedCalendarException": { @@ -27967,6 +28276,9 @@ "smithy.api#documentation": "

The description of the association that was updated.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateAssociationStatus": { @@ -28039,6 +28351,9 @@ "smithy.api#documentation": "

Information about the association.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateDocument": { @@ -28142,6 +28457,9 @@ "smithy.api#documentation": "

The description of a custom document that you want to set as the default version.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateDocumentMetadata": { @@ -28272,6 +28590,9 @@ "smithy.api#documentation": "

A description of the document that was updated.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateMaintenanceWindow": { @@ -28467,6 +28788,9 @@ "smithy.api#documentation": "

Whether the maintenance window is enabled.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateMaintenanceWindowTarget": { @@ -28581,6 +28905,9 @@ "smithy.api#documentation": "

The updated description.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateMaintenanceWindowTask": { @@ -28805,6 +29132,9 @@ "smithy.api#documentation": "

The details for the CloudWatch alarm you applied to your maintenance window\n task.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateManagedInstanceRole": { @@ -28851,7 +29181,10 @@ }, "com.amazonaws.ssm#UpdateManagedInstanceRoleResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#UpdateOpsItem": { "type": "operation", @@ -28882,7 +29215,7 @@ } ], "traits": { - "smithy.api#documentation": "

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with\n OpsCenter in the Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

\n

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" } }, "com.amazonaws.ssm#UpdateOpsItemRequest": { @@ -28897,7 +29230,7 @@ "OperationalData": { "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem\n object.

\n

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem\n object.

\n

Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

\n \n

Operational data keys can't begin with the following:\n amazon, aws, amzn, ssm,\n /amazon, /aws, /amzn, /ssm.

\n \n

You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API operation) can view and search on the\n specified data. Operational data that isn't searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API operation).

\n

Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see\n Creating OpsItems\n manually in the Amazon Web Services Systems Manager User Guide.

" } }, "OperationalDataToDelete": { @@ -28927,7 +29260,7 @@ "Status": { "target": "com.amazonaws.ssm#OpsItemStatus", "traits": { - "smithy.api#documentation": "

The OpsItem status. Status can be Open, In Progress, or\n Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

The OpsItem status. Status can be Open, In Progress, or\n Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

" } }, "OpsItemId": { @@ -29062,6 +29395,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdatePatchBaseline": { @@ -29255,6 +29591,9 @@ "smithy.api#documentation": "

Information about the patches to use to update the managed nodes, including target operating\n systems and source repositories. Applies to Linux managed nodes only.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssm#UpdateResourceDataSync": { @@ -29314,7 +29653,10 @@ }, "com.amazonaws.ssm#UpdateResourceDataSyncResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ssm#UpdateServiceSetting": { "type": "operation", @@ -29345,7 +29687,7 @@ "SettingId": { "target": "com.amazonaws.ssm#ServiceSettingId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service setting to update. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.

\n \n \n

Permissions to update the /ssm/managed-instance/default-ec2-instance-management-role setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

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

The Amazon Resource Name (ARN) of the service setting to update. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.

\n \n \n

Permissions to update the\n /ssm/managed-instance/default-ec2-instance-management-role setting should only be\n provided to administrators. Implement least privilege access when allowing individuals to\n configure or modify the Default Host Management Configuration.

\n ", "smithy.api#required": {} } }, @@ -29366,7 +29708,8 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The result body of the UpdateServiceSetting API operation.

" + "smithy.api#documentation": "

The result body of the UpdateServiceSetting API operation.

", + "smithy.api#output": {} } }, "com.amazonaws.ssm#Url": { diff --git a/codegen/sdk/aws-models/verifiedpermissions.json b/codegen/sdk/aws-models/verifiedpermissions.json index 4a1ea83e97f..ee9f93ca1f0 100644 --- a/codegen/sdk/aws-models/verifiedpermissions.json +++ b/codegen/sdk/aws-models/verifiedpermissions.json @@ -65,7 +65,7 @@ "boolean": { "target": "com.amazonaws.verifiedpermissions#BooleanAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Boolean\n type.

\n

Example: {\"boolean\": true}\n

" + "smithy.api#documentation": "

An attribute value of Boolean\n type.

\n

Example: {\"boolean\": true}\n

" } }, "entityIdentifier": { @@ -77,25 +77,25 @@ "long": { "target": "com.amazonaws.verifiedpermissions#LongAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Long\n type.

\n

Example: {\"long\": 0}\n

" + "smithy.api#documentation": "

An attribute value of Long\n type.

\n

Example: {\"long\": 0}\n

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

An attribute value of String\n type.

\n

Example: {\"string\": \"abc\"}\n

" + "smithy.api#documentation": "

An attribute value of String\n type.

\n

Example: {\"string\": \"abc\"}\n

" } }, "set": { "target": "com.amazonaws.verifiedpermissions#SetAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Set\n type.

\n

Example: {\"set\": [ {} ] }\n

" + "smithy.api#documentation": "

An attribute value of Set\n type.

\n

Example: {\"set\": [ {} ] }\n

" } }, "record": { "target": "com.amazonaws.verifiedpermissions#RecordAttribute", "traits": { - "smithy.api#documentation": "

An attribute value of Record\n type.

\n

Example: {\"record\": { \"keyName\": {} } }\n

" + "smithy.api#documentation": "

An attribute value of Record\n type.

\n

Example: {\"record\": { \"keyName\": {} } }\n

" } } }, @@ -134,7 +134,7 @@ "userPoolArn": { "target": "com.amazonaws.verifiedpermissions#UserPoolArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.

\n

Example: \"UserPoolArn\":\n \"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n

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

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.

\n

Example: \"UserPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n

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

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.

\n

This data type is used as a field that is part of an Configuration structure that is\n used as a parameter to the Configuration.

\n

Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n

" + "smithy.api#documentation": "

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.

\n

This data type is used as a field that is part of an Configuration structure that is\n used as a parameter to the Configuration.

\n

Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n

" } }, "com.amazonaws.verifiedpermissions#Configuration": { @@ -155,7 +155,7 @@ "cognitoUserPoolConfiguration": { "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfiguration", "traits": { - "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n

" + "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n

" } } }, @@ -428,7 +428,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a Cedar policy and save it in the specified policy store", - "smithy.api#documentation": "

Creates a policy store. A policy store is a container for policy resources.

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

Creates a policy store. A policy store is a container for policy resources.

\n \n

Although Cedar\n supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.

\n ", "smithy.api#idempotent": {} } }, @@ -907,7 +907,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about an entity that can be referenced in a Cedar\n policy.

\n

This data type is used as one of the fields in the EntitiesDefinition\n structure.

\n

\n {\n \"id\": {\n \"entityType\": \"Photo\",\n \"entityId\": \"VacationPhoto94.jpg\"\n },\n \"Attributes\": {},\n \"Parents\": [\n {\n \"entityType\": \"Album\",\n \"entityId\": \"alice_folder\"\n }\n ]\n}\n

" + "smithy.api#documentation": "

Contains information about an entity that can be referenced in a Cedar\n policy.

\n

This data type is used as one of the fields in the EntitiesDefinition\n structure.

\n

\n { \"id\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" },\n \"Attributes\": {}, \"Parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" }\n ] }\n

" } }, "com.amazonaws.verifiedpermissions#EntityList": { @@ -1684,7 +1684,7 @@ "entities": { "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", "traits": { - "smithy.api#documentation": "

Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.

" + "smithy.api#documentation": "

Specifies the list of resources and principals and their associated attributes that\n Verified Permissions can examine when evaluating the policies.

\n \n

You can include only principal and resource entities in this parameter; you can't\n include actions. You must specify actions in the schema.

\n " } } }, @@ -1783,7 +1783,7 @@ "entities": { "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", "traits": { - "smithy.api#documentation": "

Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.

" + "smithy.api#documentation": "

Specifies the list of resources and principals and their associated attributes that\n Verified Permissions can examine when evaluating the policies.

\n \n

You can include only principal and resource entities in this parameter; you can't\n include actions. You must specify actions in the schema.

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

The request failed because one or more input parameters don't satisfy their constraint\n requirements. The output is provided as a list of fields and a reason for each field that\n isn't valid.

\n

The possible reasons include the following:

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

The request failed because one or more input parameters don't satisfy their constraint\n requirements. The output is provided as a list of fields and a reason for each field that\n isn't valid.

\n

The possible reasons include the following:

\n ", "smithy.api#error": "client" } }, @@ -3661,7 +3661,7 @@ "FederatedUser" ], "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage\n permissions for your application, and authorize user access based on those permissions.\n Using Verified Permissions, application developers can grant access based on information about the\n users, resources, and requested actions. You can also evaluate additional information\n like group membership, attributes of the resources, and session context, such as time of\n request and IP addresses. Verified Permissions manages these permissions by letting you create and\n store authorization policies for your applications, such as consumer-facing web sites\n and enterprise business systems.

\n

Verified Permissions uses Cedar as the policy language to express your permission requirements.\n Cedar supports both role-based access control (RBAC) and attribute-based access\n control (ABAC) authorization models.

\n

For more information about configuring, administering, and using Amazon Verified Permissions in your\n applications, see the Amazon Verified Permissions User Guide.

\n

For more information about the Cedar policy language, see the Cedar Policy Language Guide.

\n \n

When you write Cedar policies that reference principals, resources and actions,\n you can define the unique identifiers used for each of those elements. We strongly\n recommend that you follow these best practices:

\n \n \n

Several operations return structures that appear similar, but have different purposes.\n As new functionality is added to the product, the structure used in a parameter of one\n operation might need to change in a way that wouldn't make sense for the same parameter\n in a different operation. To help you understand the purpose of each, the following\n naming convention is used for the structures:

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

Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage\n permissions for your application, and authorize user access based on those permissions.\n Using Verified Permissions, application developers can grant access based on information about the\n users, resources, and requested actions. You can also evaluate additional information\n like group membership, attributes of the resources, and session context, such as time of\n request and IP addresses. Verified Permissions manages these permissions by letting you create and\n store authorization policies for your applications, such as consumer-facing web sites\n and enterprise business systems.

\n

Verified Permissions uses Cedar as the policy language to express your permission requirements.\n Cedar supports both role-based access control (RBAC) and attribute-based access\n control (ABAC) authorization models.

\n

For more information about configuring, administering, and using Amazon Verified Permissions in your\n applications, see the Amazon Verified Permissions User Guide.

\n

For more information about the Cedar policy language, see the Cedar Policy Language Guide.

\n \n

When you write Cedar policies that reference principals, resources and actions,\n you can define the unique identifiers used for each of those elements. We strongly\n recommend that you follow these best practices:

\n \n \n

Several operations return structures that appear similar, but have different purposes.\n As new functionality is added to the product, the structure used in a parameter of one\n operation might need to change in a way that wouldn't make sense for the same parameter\n in a different operation. To help you understand the purpose of each, the following\n naming convention is used for the structures:

\n ", "smithy.api#title": "Amazon Verified Permissions", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4023,9 +4023,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -4036,9 +4036,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -4049,9 +4049,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -4062,9 +4062,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -4075,9 +4075,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -4088,9 +4088,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -4101,9 +4101,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -4114,9 +4114,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -4125,9 +4125,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -4138,9 +4138,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -4149,9 +4149,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -4162,9 +4162,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -4175,9 +4175,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -4188,9 +4188,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -4201,9 +4201,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -4214,9 +4214,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -4225,9 +4225,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -4238,9 +4238,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -4249,9 +4249,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -4262,9 +4262,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -4275,9 +4275,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -4287,9 +4287,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -4299,9 +4299,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/gradle.properties b/gradle.properties index 0080a677f97..0d71d880228 100644 --- a/gradle.properties +++ b/gradle.properties @@ -13,7 +13,7 @@ sdkVersion=0.28.0-SNAPSHOT smithyVersion=1.29.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.22.0-SNAPSHOT +smithyKotlinVersion=0.22.0 # kotlin kotlinVersion=1.8.10 @@ -39,4 +39,4 @@ mockkVersion=1.13.3 slf4jVersion=2.0.6 # dokka config (values specified at build-time as needed) -smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/ \ No newline at end of file +smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/ From a62d7b34a081f85d052cc219f49e93d81a3f7d1d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 29 Jun 2023 17:22:13 +0000 Subject: [PATCH 2/3] chore: release 0.28.0-beta --- .changes/1397b538-9c3d-49f6-a0ae-d2781e442ed1.json | 8 -------- .changes/1d5c8d89-ed94-4dc3-9845-468b9cf359c8.json | 8 -------- .changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json | 5 ----- CHANGELOG.md | 9 +++++++++ gradle.properties | 4 ++-- 5 files changed, 11 insertions(+), 23 deletions(-) delete mode 100644 .changes/1397b538-9c3d-49f6-a0ae-d2781e442ed1.json delete mode 100644 .changes/1d5c8d89-ed94-4dc3-9845-468b9cf359c8.json delete mode 100644 .changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json diff --git a/.changes/1397b538-9c3d-49f6-a0ae-d2781e442ed1.json b/.changes/1397b538-9c3d-49f6-a0ae-d2781e442ed1.json deleted file mode 100644 index 5ab50de0d2b..00000000000 --- a/.changes/1397b538-9c3d-49f6-a0ae-d2781e442ed1.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "id": "1397b538-9c3d-49f6-a0ae-d2781e442ed1", - "type": "feature", - "description": "Add adaptive retry mode", - "issues": [ - "awslabs/aws-sdk-kotlin#701" - ] -} \ No newline at end of file diff --git a/.changes/1d5c8d89-ed94-4dc3-9845-468b9cf359c8.json b/.changes/1d5c8d89-ed94-4dc3-9845-468b9cf359c8.json deleted file mode 100644 index 6a76597e5df..00000000000 --- a/.changes/1d5c8d89-ed94-4dc3-9845-468b9cf359c8.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "id": "1d5c8d89-ed94-4dc3-9845-468b9cf359c8", - "type": "feature", - "description": "**Breaking**: Simplify mechanisms for setting/updating retry strategies in client config. See [this discussion post](https://github.com/awslabs/aws-sdk-kotlin/discussions/964) for more details.", - "issues": [ - "awslabs/aws-sdk-kotlin#701" - ] -} \ No newline at end of file diff --git a/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json b/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json deleted file mode 100644 index d94e49d1f4e..00000000000 --- a/.changes/f85d252e-e400-4b2e-b480-b5ca157555a5.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "id": "f85d252e-e400-4b2e-b480-b5ca157555a5", - "type": "misc", - "description": "Sync AWS models and bump smithy-kotlin version" -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 60f487500a7..685e7d41171 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [0.28.0-beta] - 06/29/2023 + +### Features +* [#701](https://github.com/awslabs/aws-sdk-kotlin/issues/701) **Breaking**: Simplify mechanisms for setting/updating retry strategies in client config. See [this discussion post](https://github.com/awslabs/aws-sdk-kotlin/discussions/964) for more details. +* [#701](https://github.com/awslabs/aws-sdk-kotlin/issues/701) Add adaptive retry mode + +### Miscellaneous +* Sync AWS models and bump smithy-kotlin version + ## [0.27.2-beta] - 06/22/2023 ### Miscellaneous diff --git a/gradle.properties b/gradle.properties index 0d71d880228..d26eca2a94c 100644 --- a/gradle.properties +++ b/gradle.properties @@ -7,7 +7,7 @@ kotlin.mpp.enableCompatibilityMetadataVariant=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=0.28.0-SNAPSHOT +sdkVersion=0.28.0-beta # codegen smithyVersion=1.29.0 @@ -39,4 +39,4 @@ mockkVersion=1.13.3 slf4jVersion=2.0.6 # dokka config (values specified at build-time as needed) -smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/ +smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinVersion/ \ No newline at end of file From 96c1635e233e9c41a31b4bfe5f97c176dd0113b4 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 29 Jun 2023 17:22:14 +0000 Subject: [PATCH 3/3] chore: bump snapshot version to 0.28.1-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index d26eca2a94c..c15d8914777 100644 --- a/gradle.properties +++ b/gradle.properties @@ -7,7 +7,7 @@ kotlin.mpp.enableCompatibilityMetadataVariant=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=0.28.0-beta +sdkVersion=0.28.1-SNAPSHOT # codegen smithyVersion=1.29.0