From 0f750df37ab90102e8698c1e7fdb13ad43be1762 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 30 Apr 2024 18:07:32 +0000 Subject: [PATCH 1/3] feat: update AWS API models --- codegen/sdk/aws-models/chime-sdk-voice.json | 18 +- codegen/sdk/aws-models/codeartifact.json | 58 +- codegen/sdk/aws-models/fms.json | 83 +- codegen/sdk/aws-models/omics.json | 245 ++- codegen/sdk/aws-models/opensearch.json | 13 +- .../sdk/aws-models/pinpoint-sms-voice-v2.json | 1641 ++++++++++++++++- codegen/sdk/aws-models/qbusiness.json | 831 ++++++++- codegen/sdk/aws-models/quicksight.json | 253 ++- codegen/sdk/aws-models/route53resolver.json | 47 +- codegen/sdk/aws-models/sagemaker.json | 71 + codegen/sdk/aws-models/signer.json | 4 +- 11 files changed, 3041 insertions(+), 223 deletions(-) diff --git a/codegen/sdk/aws-models/chime-sdk-voice.json b/codegen/sdk/aws-models/chime-sdk-voice.json index 00a5d3473ca..3a4bc20fca4 100644 --- a/codegen/sdk/aws-models/chime-sdk-voice.json +++ b/codegen/sdk/aws-models/chime-sdk-voice.json @@ -465,7 +465,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates one or more phone numbers.

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

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each \n UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.\n

\n \n

You cannot have a duplicate phoneNumberId in a request.

\n ", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers?operation=batch-update", @@ -4178,7 +4178,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the Alexa Skill configuration for the SIP media application.

", + "smithy.api#deprecated": { + "message": "Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." + }, + "smithy.api#documentation": "

Gets the Alexa Skill configuration for the SIP media application.

\n \n

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.

\n ", "smithy.api#http": { "method": "GET", "uri": "/sip-media-applications/{SipMediaApplicationId}/alexa-skill-configuration", @@ -7536,7 +7539,10 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Alexa Skill configuration for the SIP media application.

", + "smithy.api#deprecated": { + "message": "Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties)." + }, + "smithy.api#documentation": "

Updates the Alexa Skill configuration for the SIP media application.

\n \n

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/sip-media-applications/{SipMediaApplicationId}/alexa-skill-configuration", @@ -8620,7 +8626,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Alexa Skill configuration of a SIP media application.

" + "smithy.api#documentation": "

The Alexa Skill configuration of a SIP media application.

\n \n

Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to \n the Alexa Smart Properties page.

\n " } }, "com.amazonaws.chimesdkvoice#SipMediaApplicationCall": { @@ -9752,7 +9758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates phone number details, such as product type or calling name, for the \n specified phone number ID. You can update one phone number detail at a time. For \n example, you can update either the product type or the calling name in one action.

\n

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media \n Application Dial-In product type.

\n

Updates to outbound calling names can take 72 hours to complete. Pending \n updates to outbound calling names must be complete before you can request another \n update.

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

Updates phone number details, such as product type, calling name, or phone number name for the \n specified phone number ID. You can update one phone number detail at a time. For \n example, you can update either the product type, calling name, or phone number name in one action.

\n

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media \n Application Dial-In product type.

\n

Updates to outbound calling names can take 72 hours to complete. Pending \n updates to outbound calling names must be complete before you can request another \n update.

", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers/{PhoneNumberId}", @@ -9786,7 +9792,7 @@ "Name": { "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", "traits": { - "smithy.api#documentation": "

Specifies the name assigned to one or more phone numbers.

" + "smithy.api#documentation": "

Specifies the updated name assigned to one or more phone numbers.

" } } }, diff --git a/codegen/sdk/aws-models/codeartifact.json b/codegen/sdk/aws-models/codeartifact.json index 3aef470d06a..5149e07c29e 100644 --- a/codegen/sdk/aws-models/codeartifact.json +++ b/codegen/sdk/aws-models/codeartifact.json @@ -262,7 +262,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the associated package. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the associated package. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -461,7 +461,7 @@ "name": "codeartifact" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

CodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.

\n

\n CodeArtifact concepts\n

\n \n

\n CodeArtifact supported API operations\n

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

CodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.

\n

\n CodeArtifact concepts\n

\n \n

\n CodeArtifact supported API operations\n

\n ", "smithy.api#title": "CodeArtifact", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1362,7 +1362,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when copying package versions of the following formats:

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

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when copying package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -2022,7 +2022,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when deleting packages of the following formats:

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

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when deleting packages of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -2124,7 +2124,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when deleting package versions of the following formats:

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

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when deleting package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -2563,7 +2563,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when requesting packages of the following formats:

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

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

\n \n

The namespace is required when requesting packages of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -2669,7 +2669,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the requested package version. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting package versions of the following formats:

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

The namespace of the requested package version. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -2965,7 +2965,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package versions to be disposed. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when disposing package versions of the following formats:

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

The namespace of the package versions to be disposed. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when disposing package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -3266,7 +3266,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package from which to get the associated package group. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when getting associated package groups from packages of the following formats:

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

The namespace of the package from which to get the associated package group. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when getting associated package groups from packages of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -3533,7 +3533,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version with the requested asset file. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting assets from package versions of the following formats:

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

The namespace of the package version with the requested asset file. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting assets from package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -3681,7 +3681,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting the readme from package versions of the following formats:

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

The namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when requesting the readme from package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -3718,7 +3718,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package version with the requested readme file. The package component that specifies its \n namespace depends on its type. For example:

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

\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

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

\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

\n ", "smithy.api#http": { "method": "GET", "uri": "/v1/repository/endpoint", @@ -4522,7 +4522,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required requesting assets from package versions of the following formats:

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

The namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required requesting assets from package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -4573,7 +4573,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package version that contains the requested package version assets. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -4682,7 +4682,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version with the requested dependencies. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when listing dependencies from package versions of the following formats:

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

The namespace of the package version with the requested dependencies. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when listing dependencies from package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -4726,7 +4726,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version that contains the returned dependencies. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package version that contains the returned dependencies. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -4850,7 +4850,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when deleting package versions of the following formats:

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

The namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:

\n \n

The namespace is required when deleting package versions of the following formats:

\n \n \n ", "smithy.api#httpQuery": "namespace" } }, @@ -4920,7 +4920,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -5031,7 +5031,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace prefix used to filter requested packages. \n Only packages with a namespace that starts with the provided string value are returned. \n Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

\n

Each package format uses namespace as follows:

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

The namespace prefix used to filter requested packages. \n Only packages with a namespace that starts with the provided string value are returned. \n Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

\n

Each package format uses namespace as follows:

\n ", "smithy.api#httpQuery": "namespace" } }, @@ -5500,7 +5500,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package that this package depends on. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package that this package depends on. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -5544,7 +5544,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "name": { @@ -5597,6 +5597,12 @@ "smithy.api#enumValue": "generic" } }, + "RUBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ruby" + } + }, "SWIFT": { "target": "smithy.api#Unit", "traits": { @@ -6038,7 +6044,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "package": { @@ -6086,7 +6092,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package version. The package component that specifies its \n namespace depends on its type. For example:

\n " } }, "packageName": { @@ -6768,7 +6774,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package to be updated. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package to be updated. The package component that specifies its \n namespace depends on its type. For example:

\n ", "smithy.api#httpQuery": "namespace" } }, @@ -7733,7 +7739,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the package version to be updated. The package component that specifies its \n namespace depends on its type. For example:

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

The namespace of the package version to be updated. The package component that specifies its \n namespace depends on its type. For example:

\n ", "smithy.api#httpQuery": "namespace" } }, diff --git a/codegen/sdk/aws-models/fms.json b/codegen/sdk/aws-models/fms.json index 3a7b700d25a..3d53d7ff4ce 100644 --- a/codegen/sdk/aws-models/fms.json +++ b/codegen/sdk/aws-models/fms.json @@ -2970,7 +2970,7 @@ "EntryDetail": { "target": "com.amazonaws.fms#NetworkAclEntry", "traits": { - "smithy.api#documentation": "

Describes a rule in a network ACL.

\n

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.

\n

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

" + "smithy.api#documentation": "

Describes a rule in a network ACL.

\n

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.

\n

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

" } }, "EntryRuleNumber": { @@ -4310,13 +4310,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" } } }, @@ -4336,7 +4336,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4379,13 +4379,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" } } }, @@ -4405,7 +4405,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4609,13 +4609,13 @@ "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

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

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4635,7 +4635,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4907,13 +4907,13 @@ "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

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

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4934,7 +4934,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } } }, @@ -4971,13 +4971,13 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want Firewall Manager to return for this request. If more\n objects are available, in the response, Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

" } } }, @@ -4997,7 +4997,7 @@ "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

Describes a rule in a network ACL.

\n

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.

\n

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

" + "smithy.api#documentation": "

Describes a rule in a network ACL.

\n

Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining\nwhether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the\n entries in the network ACL according to the rule numbers, in ascending order.

\n

When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, \n you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order \n that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.

" } }, "com.amazonaws.fms#NetworkAclEntrySet": { @@ -5269,26 +5269,26 @@ "FirstEntries": { "target": "com.amazonaws.fms#NetworkAclEntries", "traits": { - "smithy.api#documentation": "

The rules that you want to run first in the Firewall Manager managed network ACLs.

\n \n

Provide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.

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

The rules that you want to run first in the Firewall Manager managed network ACLs.

\n \n

Provide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.

\n \n

You must specify at least one first entry or one last entry in any network ACL policy.

" } }, "ForceRemediateForFirstEntries": { "target": "com.amazonaws.fms#BooleanObject", "traits": { - "smithy.api#documentation": "

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.

\n

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n Network access control list (ACL) policies \n in the Firewall Manager Developer Guide.

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

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.

\n

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.

", "smithy.api#required": {} } }, "LastEntries": { "target": "com.amazonaws.fms#NetworkAclEntries", "traits": { - "smithy.api#documentation": "

The rules that you want to run last in the Firewall Manager managed network ACLs.

\n \n

Provide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.

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

The rules that you want to run last in the Firewall Manager managed network ACLs.

\n \n

Provide these in the order in which you want them to run. Firewall Manager will assign\n the specific rule numbers for you, in the network ACLs that it creates.

\n \n

You must specify at least one first entry or one last entry in any network ACL policy.

" } }, "ForceRemediateForLastEntries": { "target": "com.amazonaws.fms#BooleanObject", "traits": { - "smithy.api#documentation": "

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.

\n

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \n Network access control list (ACL) policies \n in the Firewall Manager Developer Guide.

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

Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy \n violations that involve conflicts between the custom entries and the policy entries.

\n

If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to \n remediate. For more information about the remediation behavior, see \nNetwork access control list (ACL) policies \n in the Firewall Manager Developer Guide.

", "smithy.api#required": {} } } @@ -6121,7 +6121,7 @@ "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" + "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" } }, "IncludeMap": { @@ -6363,7 +6363,7 @@ "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" + "smithy.api#documentation": "

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources\n that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL\n from a protected customer resource when the customer resource leaves policy scope.

\n

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

\n

This option is not available for Shield Advanced or WAF Classic policies.

" } }, "PolicyStatus": { @@ -7941,7 +7941,13 @@ "RuleOrder": { "target": "com.amazonaws.fms#RuleOrder", "traits": { - "smithy.api#documentation": "

Indicates how to manage the order of stateful rule evaluation for the policy.\nDEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine\nas Suricata compatible strings, and Suricata evaluates them based on certain settings. For more\ninformation, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

" + "smithy.api#documentation": "

Indicates how to manage the order of stateful rule evaluation for the policy.\nStateful rules are provided to the rule engine\nas Suricata compatible strings, and Suricata evaluates them based on certain settings. For more\ninformation, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

\n

Default: DEFAULT_ACTION_ORDER\n

" + } + }, + "StreamExceptionPolicy": { + "target": "com.amazonaws.fms#StreamExceptionPolicy", + "traits": { + "smithy.api#documentation": "

Indicates how Network Firewall should handle traffic when a network connection breaks midstream.

\n \n

For more information, see \n Stream exception policy in your firewall policy \n in the Network Firewall Developer Guide.

\n

Default: FMS_IGNORE\n

" } } }, @@ -8028,6 +8034,35 @@ } } }, + "com.amazonaws.fms#StreamExceptionPolicy": { + "type": "enum", + "members": { + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + }, + "CONTINUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUE" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + }, + "FMS_IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FMS_IGNORE" + } + } + } + }, "com.amazonaws.fms#Tag": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index 7214d5b5fa0..f3db885ee59 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -125,7 +125,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nAccepts a share for an analytics store. \n

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

Accept a resource share request.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -142,7 +142,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\nThe ID for a share offer for analytics store data. \n

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

The ID of the resource share.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -158,7 +158,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "

\nThe status of an analytics store share. \n

" + "smithy.api#documentation": "

The status of the resource share.

" } } }, @@ -508,6 +508,9 @@ }, "list": { "target": "com.amazonaws.omics#ListAnnotationStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores annotation data" } }, "com.amazonaws.omics#AnnotationStoreItem": { @@ -1263,6 +1266,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an Annotation Store" + }, "smithy.api#documentation": "

Creates an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2192,7 +2198,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber. \n

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

Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).

\n

The following resources support cross-account sharing:

\n ", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -2209,21 +2215,21 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The resource ARN for the analytics store to be shared.\n

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

The ARN of the resource to be shared.

", "smithy.api#required": {} } }, "principalSubscriber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The principal subscriber is the account being given access to the analytics store data through the share offer. \n

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

The principal subscriber is the account being offered shared access to the resource.

", "smithy.api#required": {} } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "

\n A name given to the share. \n

" + "smithy.api#documentation": "

A name that the owner defines for the share.

" } } }, @@ -2237,19 +2243,19 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n An ID generated for the share. \n

" + "smithy.api#documentation": "

The ID that HealthOmics generates for the share.

" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "

\n The status of a share. \n

" + "smithy.api#documentation": "

The status of the share.

" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "

\n A name given to the share. \n

" + "smithy.api#documentation": "

The name of the share.

" } } }, @@ -2289,6 +2295,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a Variant Store" + }, "smithy.api#documentation": "

Creates a variant store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2476,7 +2485,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A storage capacity for the workflow in gibibytes.

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

The storage capacity for the workflow in gibibytes.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -2590,6 +2599,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an Annotation Store" + }, "smithy.api#documentation": "

Deletes an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3097,7 +3109,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Deletes a share of an analytics store. \n

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

Deletes a resource share. If you are the resource owner, the subscriber will no longer have \n access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -3115,7 +3127,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The ID for the share request to be deleted. \n

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

The ID for the resource share to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3131,7 +3143,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "

\n The status of the share being deleted. \n

" + "smithy.api#documentation": "

The status of the share being deleted.

" } } }, @@ -3168,6 +3180,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a Variant Store" + }, "smithy.api#documentation": "

Deletes a variant store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3644,18 +3659,24 @@ "resourceArns": { "target": "com.amazonaws.omics#ArnList", "traits": { - "smithy.api#documentation": "

\nThe Amazon Resource Number (Arn) for an analytics store. \n

" + "smithy.api#documentation": "

Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.

" } }, "status": { "target": "com.amazonaws.omics#StatusList", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version. \n

" + "smithy.api#documentation": "

Filter based on the resource status. You can specify up to 10 values.

" + } + }, + "type": { + "target": "com.amazonaws.omics#TypeList", + "traits": { + "smithy.api#documentation": "

The type of resources to be filtered. You can specify one or more of the resource types.

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

\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n

" + "smithy.api#documentation": "

Use filters to return a subset of resources. You can define filters for specific parameters,\n such as the resource status.

" } }, "com.amazonaws.omics#FormatOptions": { @@ -3971,6 +3992,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about an Annotation Store" + }, "smithy.api#documentation": "

Gets information about an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -5935,7 +5959,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow run.

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

Gets information about a workflow run.

\n

If a workflow is shared with you, you cannot export information about the run.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6325,7 +6349,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The run's storage capacity in gigabytes.

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

The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -6421,6 +6445,18 @@ "traits": { "smithy.api#documentation": "

The destination for workflow outputs.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The run's storage type.

" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "

The ID of the workflow owner.

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

\n Retrieves the metadata for a share. \n

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

Retrieves the metadata for the specified resource share.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -6893,7 +6929,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The generated ID for a share. \n

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

The ID of the share.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6909,7 +6945,7 @@ "share": { "target": "com.amazonaws.omics#ShareDetails", "traits": { - "smithy.api#documentation": "

\n An analytic store share details object. contains status, resourceArn, ownerId, etc. \n

" + "smithy.api#documentation": "

A resource share details object. The object includes the status, the resourceArn, and ownerId.

" } } }, @@ -7140,6 +7176,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about a Variant Store" + }, "smithy.api#documentation": "

Gets information about a variant store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -7377,7 +7416,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow.

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

Gets information about a workflow.

\n

If a workflow is shared with you, you cannot export the workflow.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -7462,6 +7501,13 @@ "smithy.api#documentation": "

The export format for the workflow.

", "smithy.api#httpQuery": "export" } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "

The ID of the workflow owner.

", + "smithy.api#httpQuery": "workflowOwnerId" + } } }, "traits": { @@ -7542,7 +7588,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The workflow's storage capacity in gigabytes.

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

The workflow's storage capacity in gibibytes.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -8169,12 +8215,12 @@ "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "

\nThe status of an annotation store version. \n

" + "smithy.api#documentation": "

The status of an annotation store version.

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

\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n

" + "smithy.api#documentation": "

Use filters to focus the returned annotation store versions on a specific parameter,\n such as the status of the annotation store.

" } }, "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { @@ -8267,6 +8313,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of information about Annotation Stores" + }, "smithy.api#documentation": "

Retrieves a list of annotation stores.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -9810,7 +9859,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Lists all shares associated with an account. \n

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

Retrieves the resource shares associated with an account. Use the filter parameter to \n retrieve a specific subset of the shares.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -9834,27 +9883,27 @@ "resourceOwner": { "target": "com.amazonaws.omics#ResourceOwner", "traits": { - "smithy.api#documentation": "

\n The account that owns the analytics store shared. \n

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

The account that owns the resource shares.

", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.omics#Filter", "traits": { - "smithy.api#documentation": "

\n Attributes used to filter for a specific subset of shares. \n

" + "smithy.api#documentation": "

Attributes that you use to filter for a specific subset of resource shares.

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

\n Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.\n

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

Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n The maximum number of shares to return in one page of results.\n

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

The maximum number of shares to return in one page of results.

", "smithy.api#httpQuery": "maxResults" } } @@ -9869,7 +9918,7 @@ "shares": { "target": "com.amazonaws.omics#ShareDetailsList", "traits": { - "smithy.api#documentation": "

\n The shares available and their meta details. \n

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

The shares available and their metadata details.

", "smithy.api#required": {} } }, @@ -10118,6 +10167,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of metadata for Variant Stores" + }, "smithy.api#documentation": "

Retrieves a list of variant stores.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -10275,14 +10327,14 @@ "type": { "target": "com.amazonaws.omics#WorkflowType", "traits": { - "smithy.api#documentation": "

The workflows' type.

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

Filter the list by workflow type.

", "smithy.api#httpQuery": "type" } }, "name": { "target": "com.amazonaws.omics#WorkflowName", "traits": { - "smithy.api#documentation": "

The workflows' name.

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

Filter the list by workflow name.

", "smithy.api#httpQuery": "name" } }, @@ -10315,7 +10367,7 @@ "items": { "target": "com.amazonaws.omics#WorkflowList", "traits": { - "smithy.api#documentation": "

The workflows' items.

" + "smithy.api#documentation": "

A list of workflow items.

" } }, "nextToken": { @@ -12865,7 +12917,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The run's storage capacity.

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

The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -12889,6 +12941,12 @@ "traits": { "smithy.api#documentation": "

When the run stopped.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The run's storage type.

" + } } }, "traits": { @@ -13586,60 +13644,66 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The ID for a share offer for an analytics store .\n

" + "smithy.api#documentation": "

The ID of the resource share.

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

\n The resource Arn of the analytics store being shared. \n

" + "smithy.api#documentation": "

The Arn of the shared resource.

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

The ID of the shared resource.

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

\n The principal subscriber is the account the analytics store data is being shared with. \n

" + "smithy.api#documentation": "

The principal subscriber is the account that is sharing the resource.

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

\n The account ID for the data owner. The owner creates the share offer. \n

" + "smithy.api#documentation": "

The account ID for the data owner. The owner creates the resource share.

" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "

\n The status of a share. \n

" + "smithy.api#documentation": "

The status of the share.

" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "

\n The status message for a share. It provides more details on the status of the share.\n

" + "smithy.api#documentation": "

The status message for a resource share. It provides additional details about the share status.

" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "

\n The name of the share. \n

" + "smithy.api#documentation": "

The name of the resource share.

" } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "

\n The timestamp for when the share was created. \n

" + "smithy.api#documentation": "

The timestamp of when the resource share was created.

" } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "

\n The timestamp of the share update. \n

" + "smithy.api#documentation": "

The timestamp of the resource share update.

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

\n The details of a share. \n

" + "smithy.api#documentation": "

The details of a resource share.

" } }, "com.amazonaws.omics#ShareDetailsList": { @@ -13658,6 +13722,28 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, + "com.amazonaws.omics#ShareResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARIANT_STORE", + "name": "VARIANT_STORE", + "documentation": "The share is on a variant store" + }, + { + "value": "ANNOTATION_STORE", + "name": "ANNOTATION_STORE", + "documentation": "The share is on an annotation store" + }, + { + "value": "WORKFLOW", + "name": "WORKFLOW", + "documentation": "The share is on a workflow" + } + ] + } + }, "com.amazonaws.omics#ShareStatus": { "type": "string", "traits": { @@ -14520,7 +14606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.

\n

The total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.

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

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.

\n

StartRun will not support re-run for a workflow that is shared with you.

\n

The total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.

\n

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. \n You can set the storage type to DYNAMIC. You do not set storageCapacity,\n because HealthOmics dynamically scales the storage up or down as required.\n For more information about static and dynamic storage, see Running workflows \n in the AWS HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -14590,7 +14676,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A storage capacity for the run in gibibytes.

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

A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic\n (the system ignores any value that you enter).

", "smithy.api#range": { "min": 0, "max": 100000 @@ -14628,6 +14714,18 @@ "traits": { "smithy.api#documentation": "

The retention mode for the run.

" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "

The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage.\n If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up \n or down, based on file system utilization.

" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "

The ID of the workflow owner.

" + } } }, "traits": { @@ -14781,6 +14879,10 @@ "target": "com.amazonaws.omics#ShareStatus" }, "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, "smithy.api#uniqueItems": {} } }, @@ -14793,6 +14895,25 @@ } } }, + "com.amazonaws.omics#StorageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATIC", + "value": "STATIC" + }, + { + "name": "DYNAMIC", + "value": "DYNAMIC" + } + ], + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.omics#StoreFormat": { "type": "string", "traits": { @@ -15333,6 +15454,19 @@ "smithy.api#documentation": "

\nThe options for a TSV file.\n

" } }, + "com.amazonaws.omics#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#UntagResource": { "type": "operation", "input": { @@ -15437,6 +15571,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update information about the Annotation Store" + }, "smithy.api#documentation": "

Updates an annotation store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -15810,6 +15947,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update metadata about the Variant Store" + }, "smithy.api#documentation": "

Updates a variant store.

", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -16295,6 +16435,9 @@ }, "list": { "target": "com.amazonaws.omics#ListVariantStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores variant data" } }, "com.amazonaws.omics#VariantStoreItem": { @@ -16722,6 +16865,12 @@ "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" } }, + "com.amazonaws.omics#WorkflowOwnerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.omics#WorkflowParameter": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/opensearch.json b/codegen/sdk/aws-models/opensearch.json index 8157d81a080..078f76fc48a 100644 --- a/codegen/sdk/aws-models/opensearch.json +++ b/codegen/sdk/aws-models/opensearch.json @@ -373,7 +373,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of\n case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see\n Tagging Amazon OpenSearch Service domains.

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

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of\n case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see\n Tagging Amazon OpenSearch Service domains.\n

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/tags", @@ -6204,7 +6204,13 @@ "Endpoints": { "target": "com.amazonaws.opensearch#EndpointsMap", "traits": { - "smithy.api#documentation": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example\n key, value:\n 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + "smithy.api#documentation": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

\n " + } + }, + "DomainEndpointV2HostedZoneId": { + "target": "com.amazonaws.opensearch#HostedZoneId", + "traits": { + "smithy.api#documentation": "

The DualStack Hosted Zone Id for the domain.

" } }, "Processing": { @@ -7229,6 +7235,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#HostedZoneId": { + "type": "string" + }, "com.amazonaws.opensearch#IPAddressType": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json index 4c6511fc432..636f1cc0e63 100644 --- a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json +++ b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json @@ -69,6 +69,10 @@ { "value": "ACCOUNT_TIER", "name": "ACCOUNT_TIER" + }, + { + "value": "DEFAULT_PROTECT_CONFIGURATION_ID", + "name": "DEFAULT_PROTECT_CONFIGURATION_ID" } ] } @@ -268,6 +272,96 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a protect configuration with a configuration set. This replaces the\n configuration sets current protect configuration. A configuration set can\n only be associated with one protect configuration at a time. A protect configuration can\n be associated with multiple configuration sets.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

", + "smithy.api#required": {} + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the ConfigurationSet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration set.

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

The name of the ConfigurationSet.

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

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#AttachmentBody": { "type": "blob", "traits": { @@ -337,7 +431,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role\n that is able to write event data to an Amazon CloudWatch destination.

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

The Amazon Resource Name (ARN) of an Identity and Access Management role\n that is able to write event data to an Amazon CloudWatch destination.

", "smithy.api#required": {} } }, @@ -405,6 +499,10 @@ { "value": "default-sender-id", "name": "DEFAULT_SENDER_ID" + }, + { + "value": "protect-configuration-id", + "name": "PROTECT_CONFIGURATION_ID" } ] } @@ -451,6 +549,12 @@ "smithy.api#documentation": "

The time when the ConfigurationSet was created, in UNIX epoch time format.

", "smithy.api#required": {} } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

" + } } }, "traits": { @@ -651,6 +755,22 @@ { "value": "VERIFICATION_ALREADY_COMPLETE", "name": "VERIFICATION_ALREADY_COMPLETE" + }, + { + "value": "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT", + "name": "PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT" + }, + { + "value": "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET", + "name": "PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET" + }, + { + "value": "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET", + "name": "PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET" + }, + { + "value": "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION", + "name": "DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION" } ] } @@ -843,13 +963,13 @@ "CloudWatchLogsDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", "traits": { - "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon\n CloudWatch logs.

" + "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

" } }, "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.

" + "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

" } }, "SnsDestination": { @@ -1161,6 +1281,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.

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

When set to true deletion protection is enabled. By default this is set to false.\n

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

An array of key and value pair tags that are associated with the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The time when the protect configuration was created, in UNIX epoch time format.

", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the protect configuration is set as your account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When set to true deletion protection is enabled. By default this is set to false.\n

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

An array of key and value pair tags that are associated with the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#CreateRegistration": { "type": "operation", "input": { @@ -1711,6 +1938,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the current account default protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfigurationResult": { + "type": "structure", + "members": { + "DefaultProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DefaultProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the account default protect configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { "type": "operation", "input": { @@ -2108,27 +2393,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverride": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -2137,36 +2416,89 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.

\n

If the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.

" + "smithy.api#documentation": "

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Quotas for Server Migration Service\n in the Server Migration Service User Guide.

" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideRequest": { "type": "structure", - "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverrideResult": { "type": "structure", "members": { - "OptOutListArn": { - "target": "smithy.api#String", + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OptOutList that was removed.

" + "smithy.api#documentation": "

The current monthly limit, in US dollars.

" } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.

\n

If the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OptOutList that was removed.

" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { "smithy.api#documentation": "

The name of the OptOutList that was removed.

" } }, @@ -2398,6 +2730,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The time when the protect configuration was created, in UNIX epoch time format.

", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the protect configuration is set as your account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration": { "type": "operation", "input": { @@ -3571,6 +3995,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

", + "smithy.api#paginated": { + "items": "ProtectConfigurations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsRequest": { + "type": "structure", + "members": { + "ProtectConfigurationIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdList", + "traits": { + "smithy.api#documentation": "

An array of protect configuration identifiers to search for.

" + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterList", + "traits": { + "smithy.api#documentation": "

An array of ProtectConfigurationFilter objects to filter the results.

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

The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per each request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurationsResult": { + "type": "structure", + "members": { + "ProtectConfigurations": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformationList", + "traits": { + "smithy.api#documentation": "

An array of ProtectConfigurationInformation objects that contain the details for the request.

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

The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments": { "type": "operation", "input": { @@ -4634,13 +5142,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationResult" }, "errors": [ { @@ -4663,16 +5171,23 @@ } ], "traits": { - "smithy.api#documentation": "

Discard the current version of the registration.

" + "smithy.api#documentation": "

Disassociate a protect configuration from a configuration set.

" } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationRequest": { "type": "structure", "members": { - "RegistrationId": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the registration.

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

The unique identifier for the protect configuration.

", + "smithy.api#required": {} + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the ConfigurationSet.

", "smithy.api#required": {} } } @@ -4681,41 +5196,34 @@ "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfigurationResult": { "type": "structure", "members": { - "RegistrationArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the registration.

", - "smithy.api#required": {} - } - }, - "RegistrationId": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the registration.

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

The Amazon Resource Name (ARN) of the configuration set.

", "smithy.api#required": {} } }, - "VersionNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

The version number of the registration.

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

The name of the ConfigurationSet.

", "smithy.api#required": {} } }, - "RegistrationVersionStatus": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", "traits": { - "smithy.api#documentation": "

The status of the registration version.

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

The Amazon Resource Name (ARN) of the protect configuration.

", "smithy.api#required": {} } }, - "RegistrationVersionStatusHistory": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatusHistory", + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", "traits": { - "smithy.api#documentation": "

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

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

The unique identifier for the protect configuration.

", "smithy.api#required": {} } } @@ -4724,19 +5232,109 @@ "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#EventDestination": { - "type": "structure", - "members": { - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", - "traits": { - "smithy.api#documentation": "

The name of the EventDestination.

", - "smithy.api#required": {} - } - }, - "Enabled": { - "target": "smithy.api#Boolean", - "traits": { + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Discard the current version of the registration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the registration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the registration.

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

The unique identifier for the registration.

", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the registration.

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

The status of the registration version.

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

The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestination": { + "type": "structure", + "members": { + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the EventDestination.

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

When set to true events will be logged.

", "smithy.api#required": {} } @@ -4757,7 +5355,7 @@ "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.

" + "smithy.api#documentation": "

An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

" } }, "SnsDestination": { @@ -4768,7 +5366,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about an event destination.

\n

Event destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.

" + "smithy.api#documentation": "

Contains information about an event destination.

\n

Event destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.

" } }, "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { @@ -4890,6 +5488,74 @@ { "value": "VOICE_TTL_EXPIRED", "name": "VOICE_TTL_EXPIRED" + }, + { + "value": "MEDIA_ALL", + "name": "MEDIA_ALL" + }, + { + "value": "MEDIA_PENDING", + "name": "MEDIA_PENDING" + }, + { + "value": "MEDIA_QUEUED", + "name": "MEDIA_QUEUED" + }, + { + "value": "MEDIA_SUCCESSFUL", + "name": "MEDIA_SUCCESSFUL" + }, + { + "value": "MEDIA_DELIVERED", + "name": "MEDIA_DELIVERED" + }, + { + "value": "MEDIA_INVALID", + "name": "MEDIA_INVALID" + }, + { + "value": "MEDIA_INVALID_MESSAGE", + "name": "MEDIA_INVALID_MESSAGE" + }, + { + "value": "MEDIA_UNREACHABLE", + "name": "MEDIA_UNREACHABLE" + }, + { + "value": "MEDIA_CARRIER_UNREACHABLE", + "name": "MEDIA_CARRIER_UNREACHABLE" + }, + { + "value": "MEDIA_BLOCKED", + "name": "MEDIA_BLOCKED" + }, + { + "value": "MEDIA_CARRIER_BLOCKED", + "name": "MEDIA_CARRIER_BLOCKED" + }, + { + "value": "MEDIA_SPAM", + "name": "MEDIA_SPAM" + }, + { + "value": "MEDIA_UNKNOWN", + "name": "MEDIA_UNKNOWN" + }, + { + "value": "MEDIA_TTL_EXPIRED", + "name": "MEDIA_TTL_EXPIRED" + }, + { + "value": "MEDIA_FILE_INACCESSIBLE", + "name": "MEDIA_FILE_INACCESSIBLE" + }, + { + "value": "MEDIA_FILE_TYPE_UNSUPPORTED", + "name": "MEDIA_FILE_TYPE_UNSUPPORTED" + }, + { + "value": "MEDIA_FILE_SIZE_EXCEEDED", + "name": "MEDIA_FILE_SIZE_EXCEEDED" } ] } @@ -4902,7 +5568,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 43 } } }, @@ -4970,9 +5636,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 128 }, - "smithy.api#pattern": "^[\\.:A-Za-z0-9_-]+$" + "smithy.api#pattern": "^[/\\.:A-Za-z0-9_-]+$" } }, "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { @@ -4987,6 +5653,93 @@ } } }, + "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

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

The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSetResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.

", + "smithy.api#required": {} + } + }, + "CountryRuleSet": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { "type": "string", "traits": { @@ -5161,7 +5914,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.

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

The ARN of an Identity and Access Management role that is able to write\n event data to an Amazon Kinesis Data Firehose destination.

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

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event\n destination.

\n

Event destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.

" + "smithy.api#documentation": "

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Kinesis Data Firehose event\n destination.

\n

Event destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.

" } }, "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { @@ -5533,6 +6286,38 @@ } } }, + "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MediaUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaUrlValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MediaUrlValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^s3://([a-z0-9\\.-]{3,63})/(.+)$" + } + }, "com.amazonaws.pinpointsmsvoicev2#MessageType": { "type": "string", "traits": { @@ -5601,6 +6386,10 @@ { "value": "VOICE", "name": "VOICE" + }, + { + "value": "MMS", + "name": "MMS" } ] } @@ -5613,7 +6402,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 2 + "max": 3 } } }, @@ -6152,6 +6941,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" }, @@ -6164,6 +6956,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistration" }, @@ -6179,6 +6974,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteAccountDefaultProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" }, @@ -6194,6 +6992,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteMediaMessageSpendLimitOverride" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" }, @@ -6203,6 +7004,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration" }, @@ -6245,6 +7049,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeProtectConfigurations" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments" }, @@ -6278,9 +7085,15 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" }, @@ -6314,18 +7127,27 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessage" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" }, { "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfiguration" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverride" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" }, @@ -6350,6 +7172,12 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfiguration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSet" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId" }, @@ -6367,7 +7195,7 @@ "name": "sms-voice" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.

\n

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.

\n

If you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.

\n

\n Regional availability\n

\n

The Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.

\n

In each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n

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

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.

\n

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

\n

If you're new to Amazon Pinpoint SMS, it's also helpful to review the \n Amazon Pinpoint SMS User Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.

\n

\n Regional availability\n

\n

The Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.

\n

In each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7394,6 +8222,197 @@ ] } }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet": { + "type": "map", + "key": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode" + }, + "value": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSetInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSetInformation": { + "type": "structure", + "members": { + "ProtectStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectStatus", + "traits": { + "smithy.api#documentation": "

The types of protection that can be used.

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

The types of statuses that can be used.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterName", + "traits": { + "smithy.api#documentation": "

The name of the attribute to filter on.

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

An array of values to filter for.

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

The filter definition for filtering protect configurations that meet a specified criteria.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "account-default", + "name": "ACCOUNT_DEFAULT" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformation": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The time when the protect configuration was created, in UNIX epoch time format.

", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the protect configuration is set as your account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n

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

Provides information on the specified protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ProtectStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "BLOCK", + "name": "BLOCK" + } + ] + } + }, "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { "type": "operation", "input": { @@ -9516,6 +10535,10 @@ { "value": "verified-destination-number", "name": "VERIFIED_DESTINATION_NUMBER" + }, + { + "value": "protect-configuration", + "name": "PROTECT_CONFIGURATION" } ] } @@ -9725,6 +10748,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new multimedia message (MMS) and sends it to a recipient's phone number.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The destination phone number in E.164 format.

", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", + "traits": { + "smithy.api#documentation": "

The text body of the message.

" + } + }, + "MediaUrls": { + "target": "com.amazonaws.pinpointsmsvoicev2#MediaUrlList", + "traits": { + "smithy.api#documentation": "

An array of URLs to each media file to send.

\n

The media files have to be stored in a publicly available S3 bucket. Supported media file formats\n are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing\n objects, see Creating a bucket and Uploading objects in the S3 user guide.

" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.

" + } + }, + "MaxPrice": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "

The maximum amount that you want to spend, in US dollars, per each MMS message.

" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "

How long the text message is valid for. By default this is 72 hours.

" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "

You can specify custom data in this field. If you do, that data is logged to the event\n destination.

" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When set to true, the message is checked and validated, but isn't sent to the end\n recipient.

" + } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier of the protect configuration to use.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendMediaMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the message.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { "type": "operation", "input": { @@ -9830,6 +10973,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

When set to true, the message is checked and validated, but isn't sent to the end\n recipient.

" } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

" + } } }, "traits": { @@ -9950,6 +11099,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

When set to true, the message is checked and validated, but isn't sent to the end\n recipient.

" } + }, + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

" + } } }, "traits": { @@ -10200,6 +11355,10 @@ "value": "KEYWORDS_PER_POOL", "name": "KEYWORDS_PER_POOL" }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA" + }, { "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" @@ -10259,10 +11418,80 @@ { "value": "VERIFICATION_ATTEMPTS_PER_DAY", "name": "VERIFICATION_ATTEMPTS_PER_DAY" + }, + { + "value": "PROTECT_CONFIGURATIONS_PER_ACCOUNT", + "name": "PROTECT_CONFIGURATIONS_PER_ACCOUNT" } ] } }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Set a protect configuration as your account default. You can only have one account\n default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationResult": { + "type": "structure", + "members": { + "DefaultProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DefaultProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the account default protect configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { "type": "operation", "input": { @@ -10417,6 +11646,61 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets an account level monthly spend limit override for sending MMS messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideRequest": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "

The new monthly limit to enforce on text messages.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetMediaMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "

The current monthly limit to enforce on sending text messages.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { "type": "operation", "input": { @@ -10608,6 +11892,10 @@ { "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + }, + { + "value": "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT" } ] } @@ -11512,6 +12800,195 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the setting for an existing protect configuration.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

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

The number capability to apply the CountryRuleSetUpdates updates to.

", + "smithy.api#required": {} + } + }, + "CountryRuleSetUpdates": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationCountryRuleSetResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The number capability that was updated

", + "smithy.api#required": {} + } + }, + "CountryRuleSet": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", + "traits": { + "smithy.api#documentation": "

An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationRequest": { + "type": "structure", + "members": { + "ProtectConfigurationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationIdOrArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the protect configuration.

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

When set to true deletion protection is enabled. By default this is set to false.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateProtectConfigurationResult": { + "type": "structure", + "members": { + "ProtectConfigurationArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protect configuration.

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

The unique identifier for the protect configuration.

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

The time when the protect configuration was created, in UNIX epoch time format.

", + "smithy.api#required": {} + } + }, + "AccountDefault": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is true if the protect configuration is set as your account default protect configuration.

", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId": { "type": "operation", "input": { @@ -11746,6 +13223,10 @@ "value": "MAXIMUM_SIZE_EXCEEDED", "name": "MAXIMUM_SIZE_EXCEEDED" }, + { + "value": "MEDIA_TYPE_NOT_SUPPORTED", + "name": "MEDIA_TYPE_NOT_SUPPORTED" + }, { "value": "MISSING_PARAMETER", "name": "MISSING_PARAMETER" diff --git a/codegen/sdk/aws-models/qbusiness.json b/codegen/sdk/aws-models/qbusiness.json index 4489441c994..a633282693e 100644 --- a/codegen/sdk/aws-models/qbusiness.json +++ b/codegen/sdk/aws-models/qbusiness.json @@ -1,6 +1,37 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.qbusiness#APISchema": { + "type": "union", + "members": { + "payload": { + "target": "com.amazonaws.qbusiness#Payload", + "traits": { + "smithy.api#documentation": "

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.\n

" + } + }, + "s3": { + "target": "com.amazonaws.qbusiness#S3", + "traits": { + "smithy.api#documentation": "

Contains details about the S3 object containing the OpenAPI schema for a custom\n plugin. The schema could be in either JSON or YAML format.

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

Contains details about the OpenAPI schema for a custom plugin. For more information,\n see custom plugin OpenAPI schemas. You can either include\n the schema directly in the payload field or you can upload it to an S3 bucket and\n specify the S3 bucket location in the s3 field.

" + } + }, + "com.amazonaws.qbusiness#APISchemaType": { + "type": "enum", + "members": { + "OPEN_API_V3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN_API_V3" + } + } + } + }, "com.amazonaws.qbusiness#AccessConfiguration": { "type": "structure", "members": { @@ -94,6 +125,35 @@ "smithy.api#documentation": "

Performs an Amazon Q Business plugin action during a non-streaming chat\n conversation.

" } }, + "com.amazonaws.qbusiness#ActionExecutionEvent": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin for which the action is being requested.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionExecutionPayload", + "traits": { + "smithy.api#documentation": "

A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.

", + "smithy.api#required": {} + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within a action\n execution event payload.

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

A request from an end user signalling an intent to perform an Amazon Q Business plugin\n action during a streaming chat.

" + } + }, "com.amazonaws.qbusiness#ActionExecutionPayload": { "type": "map", "key": { @@ -199,6 +259,56 @@ "smithy.api#documentation": "

An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q Business.

" } }, + "com.amazonaws.qbusiness#ActionReviewEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation with which the action review event is\n associated.

" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation with which the plugin action is associated.

" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated associated with the action review\n event.

" + } + }, + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "

The identifier of the plugin associated with the action review event.

" + } + }, + "pluginType": { + "target": "com.amazonaws.qbusiness#PluginType", + "traits": { + "smithy.api#documentation": "

The type of plugin.

" + } + }, + "payload": { + "target": "com.amazonaws.qbusiness#ActionReviewPayload", + "traits": { + "smithy.api#documentation": "

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.

" + } + }, + "payloadFieldNameSeparator": { + "target": "com.amazonaws.qbusiness#ActionPayloadFieldNameSeparator", + "traits": { + "smithy.api#documentation": "

A string used to retain information about the hierarchical contexts within an action\n review event payload.

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

An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a streaming chat conversation. It contains information about the selected\n action with a list of possible user input fields, some pre-populated by Amazon Q Business.\n

" + } + }, "com.amazonaws.qbusiness#ActionReviewPayload": { "type": "map", "key": { @@ -223,6 +333,12 @@ "smithy.api#documentation": "

The display order of fields in a payload.

" } }, + "displayDescription": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The field level description of each action review input field. This could be an\n explanation of the field. In the Amazon Q Business web experience, these descriptions could\n be used to display as tool tips to help users understand the field.

" + } + }, "type": { "target": "com.amazonaws.qbusiness#ActionPayloadFieldType", "traits": { @@ -241,6 +357,12 @@ "smithy.api#documentation": "

Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.

" } }, + "allowedFormat": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The expected data format for the action review input field value. For example, in PTO\n request, from and to would be of datetime allowed\n format.

" + } + }, "required": { "target": "smithy.api#Boolean", "traits": { @@ -489,6 +611,17 @@ "smithy.api#documentation": "

A file directly uploaded into a web experience chat.

" } }, + "com.amazonaws.qbusiness#AttachmentInputEvent": { + "type": "structure", + "members": { + "attachment": { + "target": "com.amazonaws.qbusiness#AttachmentInput" + } + }, + "traits": { + "smithy.api#documentation": "

A file input event activated by a end user request to upload files into their web\n experience chat.

" + } + }, "com.amazonaws.qbusiness#AttachmentName": { "type": "string", "traits": { @@ -705,6 +838,93 @@ } } }, + "com.amazonaws.qbusiness#AuthChallengeRequest": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The URL sent by Amazon Q Business to the third party authentication server to authenticate\n a custom plugin user through an OAuth protocol.

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

A request made by Amazon Q Business to a third paty authentication server to authenticate\n a custom plugin user.

" + } + }, + "com.amazonaws.qbusiness#AuthChallengeRequestEvent": { + "type": "structure", + "members": { + "authorizationUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "

The URL sent by Amazon Q Business to a third party authentication server in response to an\n authentication verification event activated by an end user request to use a custom\n plugin.

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

An authentication verification event activated by an end user request to use a custom\n plugin.

" + } + }, + "com.amazonaws.qbusiness#AuthChallengeResponse": { + "type": "structure", + "members": { + "responseMap": { + "target": "com.amazonaws.qbusiness#AuthorizationResponseMap", + "traits": { + "smithy.api#documentation": "

The mapping of key-value pairs in an authentication challenge response.

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

Contains details of the authentication information received from a third party\n authentication server in response to an authentication challenge.

" + } + }, + "com.amazonaws.qbusiness#AuthChallengeResponseEvent": { + "type": "structure", + "members": { + "responseMap": { + "target": "com.amazonaws.qbusiness#AuthorizationResponseMap", + "traits": { + "smithy.api#documentation": "

The mapping of key-value pairs in an authentication challenge response.

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

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

" + } + }, + "com.amazonaws.qbusiness#AuthResponseKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qbusiness#AuthResponseValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.qbusiness#AuthorizationResponseMap": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#AuthResponseKey" + }, + "value": { + "target": "com.amazonaws.qbusiness#AuthResponseValue" + } + }, "com.amazonaws.qbusiness#BasicAuthConfiguration": { "type": "structure", "members": { @@ -988,6 +1208,149 @@ } } }, + "com.amazonaws.qbusiness#Chat": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#ChatInput" + }, + "output": { + "target": "com.amazonaws.qbusiness#ChatOutput" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#LicenseNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts or continues a streaming Amazon Q Business conversation.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/conversations", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#ChatInput": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business\n conversation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.qbusiness#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user attached to the chat input.

", + "smithy.api#httpQuery": "userId" + } + }, + "userGroups": { + "target": "com.amazonaws.qbusiness#UserGroups", + "traits": { + "smithy.api#documentation": "

The groups that a user associated with the chat input belongs to.

", + "smithy.api#httpQuery": "userGroups" + } + }, + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q Business conversation.

", + "smithy.api#httpQuery": "conversationId" + } + }, + "parentMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier used to associate a user message with a AI generated response.

", + "smithy.api#httpQuery": "parentMessageId" + } + }, + "clientToken": { + "target": "com.amazonaws.qbusiness#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that you provide to identify the chat input.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "inputStream": { + "target": "com.amazonaws.qbusiness#ChatInputStream", + "traits": { + "smithy.api#documentation": "

The streaming input for the Chat API.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#ChatInputStream": { + "type": "union", + "members": { + "configurationEvent": { + "target": "com.amazonaws.qbusiness#ConfigurationEvent", + "traits": { + "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat\n mode.

" + } + }, + "textEvent": { + "target": "com.amazonaws.qbusiness#TextInputEvent", + "traits": { + "smithy.api#documentation": "

Information about the payload of the ChatInputStream event containing the\n end user message input.

" + } + }, + "attachmentEvent": { + "target": "com.amazonaws.qbusiness#AttachmentInputEvent", + "traits": { + "smithy.api#documentation": "

A request by an end user to upload a file during chat.

" + } + }, + "actionExecutionEvent": { + "target": "com.amazonaws.qbusiness#ActionExecutionEvent", + "traits": { + "smithy.api#documentation": "

A request from an end user to perform an Amazon Q Business plugin action.

" + } + }, + "endOfInputEvent": { + "target": "com.amazonaws.qbusiness#EndOfInputEvent", + "traits": { + "smithy.api#documentation": "

The end of the streaming input for the Chat API.

" + } + }, + "authChallengeResponseEvent": { + "target": "com.amazonaws.qbusiness#AuthChallengeResponseEvent", + "traits": { + "smithy.api#documentation": "

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

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

The streaming input for the Chat API.

", + "smithy.api#streaming": {} + } + }, "com.amazonaws.qbusiness#ChatMode": { "type": "enum", "members": { @@ -1025,6 +1388,60 @@ "smithy.api#documentation": "

Configuration information for Amazon Q Business conversation modes.

\n

For more information, see Admin controls and guardrails and Conversation settings.

" } }, + "com.amazonaws.qbusiness#ChatOutput": { + "type": "structure", + "members": { + "outputStream": { + "target": "com.amazonaws.qbusiness#ChatOutputStream", + "traits": { + "smithy.api#documentation": "

The streaming output for the Chat API.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qbusiness#ChatOutputStream": { + "type": "union", + "members": { + "textEvent": { + "target": "com.amazonaws.qbusiness#TextOutputEvent", + "traits": { + "smithy.api#documentation": "

Information about the payload of the ChatOutputStream event containing\n the AI-generated message output.

" + } + }, + "metadataEvent": { + "target": "com.amazonaws.qbusiness#MetadataEvent", + "traits": { + "smithy.api#documentation": "

A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation.

" + } + }, + "actionReviewEvent": { + "target": "com.amazonaws.qbusiness#ActionReviewEvent", + "traits": { + "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.

" + } + }, + "failedAttachmentEvent": { + "target": "com.amazonaws.qbusiness#FailedAttachmentEvent", + "traits": { + "smithy.api#documentation": "

A failed file upload event during a web experience chat.

" + } + }, + "authChallengeRequestEvent": { + "target": "com.amazonaws.qbusiness#AuthChallengeRequestEvent", + "traits": { + "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom\n plugin.

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

The streaming output for the Chat API.

", + "smithy.api#streaming": {} + } + }, "com.amazonaws.qbusiness#ChatSync": { "type": "operation", "input": { @@ -1107,6 +1524,12 @@ "smithy.api#documentation": "

A request from an end user to perform an Amazon Q Business plugin action.

" } }, + "authChallengeResponse": { + "target": "com.amazonaws.qbusiness#AuthChallengeResponse", + "traits": { + "smithy.api#documentation": "

An authentication verification event response by a third party authentication server\n to Amazon Q Business.

" + } + }, "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { @@ -1128,7 +1551,7 @@ "chatMode": { "target": "com.amazonaws.qbusiness#ChatMode", "traits": { - "smithy.api#documentation": "

The chat modes available in an Amazon Q Business web experience.

\n \n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" + "smithy.api#documentation": "

The chat modes available to an Amazon Q Business end user.

\n \n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" } }, "chatModeConfiguration": { @@ -1182,6 +1605,12 @@ "smithy.api#documentation": "

A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.

" } }, + "authChallengeRequest": { + "target": "com.amazonaws.qbusiness#AuthChallengeRequest", + "traits": { + "smithy.api#documentation": "

An authentication verification event activated by an end user request to use a custom\n plugin.

" + } + }, "sourceAttributions": { "target": "com.amazonaws.qbusiness#SourceAttributions", "traits": { @@ -1208,6 +1637,26 @@ } } }, + "com.amazonaws.qbusiness#ConfigurationEvent": { + "type": "structure", + "members": { + "chatMode": { + "target": "com.amazonaws.qbusiness#ChatMode", + "traits": { + "smithy.api#documentation": "

The chat modes available to an Amazon Q Business end user.

\n \n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" + } + }, + "chatModeConfiguration": { + "target": "com.amazonaws.qbusiness#ChatModeConfiguration" + }, + "attributeFilter": { + "target": "com.amazonaws.qbusiness#AttributeFilter" + } + }, + "traits": { + "smithy.api#documentation": "

A configuration event activated by an end user request to select a specific chat\n mode.

" + } + }, "com.amazonaws.qbusiness#ConflictException": { "type": "structure", "members": { @@ -1429,7 +1878,7 @@ "kms:DescribeKey", "kms:CreateGrant" ], - "smithy.api#documentation": "

Creates an Amazon Q Business application.

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

Creates an Amazon Q Business application.

\n \n

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are \n also available in Amazon Q Business Lite. For information on what's included in \n Amazon Q Business Lite and what's included in \n Amazon Q Business Pro, see Amazon Q Business tiers. \n You must use the Amazon Q Business console to assign subscription tiers to users.

\n ", "smithy.api#http": { "uri": "/applications", "method": "POST" @@ -1450,8 +1899,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.

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

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.

" } }, "identityCenterInstanceArn": { @@ -1727,6 +2175,12 @@ "smithy.api#required": {} } }, + "type": { + "target": "com.amazonaws.qbusiness#IndexType", + "traits": { + "smithy.api#documentation": "

The index type that's suitable for your needs. For more information on what's included\n in each type of index or index tier, see Amazon Q Business\n tiers.

" + } + }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { @@ -1810,6 +2264,10 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], "aws.iam#requiredActions": [ "qbusiness:GetPlugin", "qbusiness:TagResource", @@ -1849,17 +2307,22 @@ "smithy.api#required": {} } }, + "authConfiguration": { + "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "traits": { + "smithy.api#required": {} + } + }, "serverUrl": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "

The source URL used for plugin configuration.

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

The source URL used for plugin configuration.

" } }, - "authConfiguration": { - "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

Contains configuration for a custom plugin.

" } }, "tags": { @@ -1895,6 +2358,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a plugin.

" } + }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "

The current status of a plugin. A plugin is modified asynchronously.

" + } } }, "traits": { @@ -2267,6 +2736,35 @@ } } }, + "com.amazonaws.qbusiness#CustomPluginConfiguration": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.qbusiness#PluginDescription", + "traits": { + "smithy.api#documentation": "

A description for your custom plugin configuration.

", + "smithy.api#required": {} + } + }, + "apiSchemaType": { + "target": "com.amazonaws.qbusiness#APISchemaType", + "traits": { + "smithy.api#documentation": "

The type of OpenAPI schema to use.

", + "smithy.api#required": {} + } + }, + "apiSchema": { + "target": "com.amazonaws.qbusiness#APISchema", + "traits": { + "smithy.api#documentation": "

Contains either details about the S3 object containing the OpenAPI schema for the\n action group or the JSON or YAML-formatted payload defining the schema.

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

Configuration information required to create a custom plugin.

" + } + }, "com.amazonaws.qbusiness#DataSource": { "type": "structure", "members": { @@ -3543,7 +4041,7 @@ "operator": { "target": "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator", "traits": { - "smithy.api#documentation": "

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Kendra currently does not support _document_body as an\n attribute key used for the condition.

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

The identifier of the document attribute used for the condition.

\n

For example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.

\n

Amazon Q Business currently does not support _document_body as an attribute\n key used for the condition.

", "smithy.api#required": {} } }, @@ -3559,7 +4057,7 @@ "type": "structure", "members": { "name": { - "target": "com.amazonaws.qbusiness#String", + "target": "com.amazonaws.qbusiness#DocumentMetadataConfigurationName", "traits": { "smithy.api#documentation": "

The name of the document attribute.

" } @@ -3864,6 +4362,16 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.qbusiness#DocumentMetadataConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" + } + }, "com.amazonaws.qbusiness#DocumentStatus": { "type": "enum", "members": { @@ -3974,6 +4482,13 @@ "smithy.api#documentation": "

Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

" } }, + "com.amazonaws.qbusiness#EndOfInputEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The end of the streaming input for the Chat API.

" + } + }, "com.amazonaws.qbusiness#ErrorCode": { "type": "enum", "members": { @@ -4073,6 +4588,9 @@ { "target": "com.amazonaws.qbusiness#BatchPutDocument" }, + { + "target": "com.amazonaws.qbusiness#Chat" + }, { "target": "com.amazonaws.qbusiness#ChatSync" }, @@ -4167,7 +4685,7 @@ "h2" ] }, - "smithy.api#documentation": "\n

Amazon Q is in preview release and is subject to change.

\n \n

This is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .

\n

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

\n

For information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.

\n

You can use the following AWS SDKs to access Amazon Q Business APIs:

\n \n

The following resources provide additional information about using the Amazon Q Business\n API:

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

This is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .

\n

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

\n

For information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.

\n

You can use the following AWS SDKs to access Amazon Q Business APIs:

\n \n

The following resources provide additional information about using the Amazon Q Business\n API:

\n ", "smithy.api#title": "QBusiness", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4537,6 +5055,35 @@ } } }, + "com.amazonaws.qbusiness#FailedAttachmentEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation associated with the failed file upload.

" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of the end user chat message associated with the file upload.

" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of the AI-generated message associated with the file upload.

" + } + }, + "attachment": { + "target": "com.amazonaws.qbusiness#AttachmentOutput" + } + }, + "traits": { + "smithy.api#documentation": "

A failed file upload during web experience chat.

" + } + }, "com.amazonaws.qbusiness#FailedDocument": { "type": "structure", "members": { @@ -5163,6 +5710,12 @@ "smithy.api#documentation": "

The name of the Amazon Q Business index.

" } }, + "type": { + "target": "com.amazonaws.qbusiness#IndexType", + "traits": { + "smithy.api#documentation": "

The type of index attached to your Amazon Q Business application.

" + } + }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { @@ -5320,6 +5873,18 @@ "authConfiguration": { "target": "com.amazonaws.qbusiness#PluginAuthConfiguration" }, + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information required to create a custom plugin.

" + } + }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "

The current status of a plugin. A plugin is modified asynchronously.

" + } + }, "pluginArn": { "target": "com.amazonaws.qbusiness#PluginArn", "traits": { @@ -5647,13 +6212,13 @@ "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp when the retriever was created.

" + "smithy.api#documentation": "

The Unix timestamp when the Amazon Q Business web experience was last created.

" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp when the data source connector was last updated.

" + "smithy.api#documentation": "

The Unix timestamp when the Amazon Q Business web experience was last updated.

" } }, "title": { @@ -5689,6 +6254,9 @@ "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { + "smithy.api#deprecated": { + "message": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, "smithy.api#documentation": "

The authentication configuration information for your Amazon Q Business web\n experience.

" } }, @@ -5850,7 +6418,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.

\n

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.

\n

You can configure your Lambda function using the\n PreExtractionHookConfiguration parameter if you want to apply advanced\n alterations on the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using\n PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#IdcApplicationArn": { @@ -6038,6 +6606,23 @@ } } }, + "com.amazonaws.qbusiness#IndexType": { + "type": "enum", + "members": { + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + }, + "STARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTER" + } + } + } + }, "com.amazonaws.qbusiness#IndexedTextBytes": { "type": "long", "traits": { @@ -7781,6 +8366,44 @@ "target": "com.amazonaws.qbusiness#Message" } }, + "com.amazonaws.qbusiness#MetadataEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation with which the generated metadata is\n associated.

" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q Business end user text input message within the\n conversation.

" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an Amazon Q Business AI generated message within the\n conversation.

" + } + }, + "sourceAttributions": { + "target": "com.amazonaws.qbusiness#SourceAttributions", + "traits": { + "smithy.api#documentation": "

The source documents used to generate the conversation response.

" + } + }, + "finalTextMessage": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The final text output message generated by the system.

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

A metadata event for a AI-generated text output message in a Amazon Q Business\n conversation, containing associated metadata generated.

" + } + }, "com.amazonaws.qbusiness#MetricValue": { "type": "string", "traits": { @@ -7817,6 +8440,13 @@ } } }, + "com.amazonaws.qbusiness#NoAuthConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Information about invoking a custom plugin without any authentication or authorization\n requirement.

" + } + }, "com.amazonaws.qbusiness#NumberAttributeBoostingConfiguration": { "type": "structure", "members": { @@ -7877,6 +8507,12 @@ "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

" } }, + "com.amazonaws.qbusiness#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qbusiness#Plugin": { "type": "structure", "members": { @@ -7910,6 +8546,12 @@ "smithy.api#documentation": "

The current status of the plugin.

" } }, + "buildStatus": { + "target": "com.amazonaws.qbusiness#PluginBuildStatus", + "traits": { + "smithy.api#documentation": "

The status of the plugin.

" + } + }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { @@ -7951,12 +8593,65 @@ "traits": { "smithy.api#documentation": "

Information about the OAuth 2.0 authentication credential/token used to configure a\n plugin.

" } + }, + "noAuthConfiguration": { + "target": "com.amazonaws.qbusiness#NoAuthConfiguration", + "traits": { + "smithy.api#documentation": "

Information about invoking a custom plugin without any authentication.

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

Authentication configuration information for an Amazon Q Business plugin.

" } }, + "com.amazonaws.qbusiness#PluginBuildStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, "com.amazonaws.qbusiness#PluginConfiguration": { "type": "structure", "members": { @@ -7972,6 +8667,15 @@ "smithy.api#documentation": "

Configuration information required to invoke chat in PLUGIN_MODE.

\n

For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.

" } }, + "com.amazonaws.qbusiness#PluginDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.qbusiness#PluginId": { "type": "string", "traits": { @@ -8066,6 +8770,12 @@ "traits": { "smithy.api#enumValue": "ZENDESK" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -8812,6 +9522,23 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.qbusiness#SnippetExcerpt": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qbusiness#SnippetExcerptText", + "traits": { + "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q chat response.

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

Contains the relevant text excerpt from a source that was used to generate a citation\n text segment in an Amazon Q Business chat response.

" + } + }, + "com.amazonaws.qbusiness#SnippetExcerptText": { + "type": "string" + }, "com.amazonaws.qbusiness#SourceAttribution": { "type": "structure", "members": { @@ -9323,6 +10050,53 @@ "smithy.api#documentation": "

Provides information about text documents in an index.

" } }, + "com.amazonaws.qbusiness#TextInputEvent": { + "type": "structure", + "members": { + "userMessage": { + "target": "com.amazonaws.qbusiness#UserMessage", + "traits": { + "smithy.api#documentation": "

A user message in a text message input event.

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

An input event for a end user message in an Amazon Q Business web experience.

" + } + }, + "com.amazonaws.qbusiness#TextOutputEvent": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.qbusiness#ConversationId", + "traits": { + "smithy.api#documentation": "

The identifier of the conversation with which the text output event is\n associated.

" + } + }, + "userMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an end user message in a TextOutputEvent.

" + } + }, + "systemMessageId": { + "target": "com.amazonaws.qbusiness#MessageId", + "traits": { + "smithy.api#documentation": "

The identifier of an AI-generated message in a TextOutputEvent.

" + } + }, + "systemMessage": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

An AI-generated message in a TextOutputEvent.

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

An output event for an AI-generated response in an Amazon Q Business web\n experience.

" + } + }, "com.amazonaws.qbusiness#TextSegment": { "type": "structure", "members": { @@ -9337,6 +10111,12 @@ "traits": { "smithy.api#documentation": "

The zero-based location in the response string where the source attribution\n ends.

" } + }, + "snippetExcerpt": { + "target": "com.amazonaws.qbusiness#SnippetExcerpt", + "traits": { + "smithy.api#documentation": "

The relevant text excerpt from a source that was used to generate a citation text\n segment in an Amazon Q Business chat response.

" + } } }, "traits": { @@ -9562,6 +10342,12 @@ "smithy.api#required": {} } }, + "identityCenterInstanceArn": { + "target": "com.amazonaws.qbusiness#InstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for—or connecting to—your Amazon Q Business application.

" + } + }, "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { @@ -10000,6 +10786,12 @@ "smithy.api#documentation": "

The source URL used for plugin configuration.

" } }, + "customPluginConfiguration": { + "target": "com.amazonaws.qbusiness#CustomPluginConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a custom plugin.

" + } + }, "authConfiguration": { "target": "com.amazonaws.qbusiness#PluginAuthConfiguration", "traits": { @@ -10273,9 +11065,18 @@ "smithy.api#required": {} } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business\n web experience and required resources.

" + } + }, "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { + "smithy.api#deprecated": { + "message": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management." + }, "smithy.api#documentation": "

The authentication configuration of the Amazon Q Business web experience.

" } }, diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 2b4cd4fca57..63489f660e3 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -866,19 +866,40 @@ "traits": { "smithy.api#documentation": "

The Q search bar that you want to use for anonymous user embedding.

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

The Generative Q&A experience that you want to use for anonymous user embedding.

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

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" } }, + "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

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

The settings that you want to use for the Generative Q&A experience.

" + } + }, "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { "type": "structure", "members": { "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", "smithy.api#required": {} } } @@ -6603,8 +6624,7 @@ "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

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

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n " } }, "AuthenticationMethod": { @@ -6657,7 +6677,7 @@ "AdminGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. This field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" } }, "AuthorGroup": { @@ -6672,6 +6692,24 @@ "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

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

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

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

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

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

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, "FirstName": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -23846,6 +23884,26 @@ "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" } }, + "com.amazonaws.quicksight#GaugeChartColorConfiguration": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color configuration of a GaugeChartVisual.

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

The background color configuration of a GaugeChartVisual.

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

The color configuration of a GaugeChartVisual.

" + } + }, "com.amazonaws.quicksight#GaugeChartConditionalFormatting": { "type": "structure", "members": { @@ -23925,6 +23983,12 @@ "smithy.api#documentation": "

The visual palette configuration of a GaugeChartVisual.

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

The color configuration of a GaugeChartVisual.

" + } + }, "Interactions": { "target": "com.amazonaws.quicksight#VisualInteractionOptions", "traits": { @@ -24268,7 +24332,7 @@ "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "

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

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

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

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

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

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

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

", "smithy.api#required": {} } }, @@ -35133,7 +35197,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -36145,6 +36209,23 @@ } } }, + "com.amazonaws.quicksight#PurchaseMode": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "AUTO_PURCHASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_PURCHASE" + } + } + } + }, "com.amazonaws.quicksight#PutDataSetRefreshProperties": { "type": "operation", "input": { @@ -36775,6 +36856,9 @@ { "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" }, + { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -38636,7 +38720,7 @@ "IdentityType": { "target": "com.amazonaws.quicksight#IdentityType", "traits": { - "smithy.api#documentation": "

Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:

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

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", "smithy.api#required": {} } }, @@ -38691,7 +38775,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" } }, "ExternalLoginFederationProviderType": { @@ -38853,19 +38937,39 @@ "traits": { "smithy.api#documentation": "

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

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

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

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

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n " } }, + "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

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

An object that provides information about the configuration of a Generative Q&A experience.

" + } + }, "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { "type": "structure", "members": { "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Q topic that you want to make the starting topic in the Q search bar.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic, a list of all shared topics is shown in the Q bar\n for your readers. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the available ones in the list.

" + "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" } } }, @@ -39470,6 +39574,24 @@ "traits": { "smithy.api#enumValue": "READER" } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } } } }, @@ -41456,7 +41578,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 2000 } } }, @@ -44182,7 +44304,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -47476,6 +47598,12 @@ "traits": { "smithy.api#documentation": "

The name of the topic.

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

The user experience version of the topic.

" + } } }, "traits": { @@ -50865,6 +50993,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

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

Determines how SPICE capacity can be purchased. The following options are available.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateTemplate": { "type": "operation", "input": { @@ -52018,7 +52225,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

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

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", "smithy.api#required": {} } }, @@ -52296,7 +52503,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

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

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n " } }, "IdentityType": { @@ -52394,6 +52601,24 @@ "traits": { "smithy.api#enumValue": "RESTRICTED_READER" } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } } } }, diff --git a/codegen/sdk/aws-models/route53resolver.json b/codegen/sdk/aws-models/route53resolver.json index f8ae5ce7185..8d56c9b1a0a 100644 --- a/codegen/sdk/aws-models/route53resolver.json +++ b/codegen/sdk/aws-models/route53resolver.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

\n

This error can also be thrown when a customer has reached the 5120 character limit for a\n\t\t\tresource policy for CloudWatch Logs.

", "smithy.api#error": "client" } }, @@ -757,10 +757,16 @@ "smithy.api#required": {} } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "

\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t

\n

\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.

\n

\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the redirection list to \n\t\tthe domain alloww list.

" + } + }, "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

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

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

\n " } } }, @@ -933,7 +939,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.route53resolver#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). \n\t\t\tInbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port \n\t\t\tthat you're using for DNS queries on your network.

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

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). \n\t\t\tInbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port \n\t\t\tthat you're using for DNS queries on your network.

\n

Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the \n\t\t\tmaximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. \n\t\t\tTo avoid connection tracking caused by security group, see \n\t\t\tUntracked connections.

", "smithy.api#required": {} } }, @@ -1369,7 +1375,7 @@ "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe DNS query type that the rule you are deleting evaluates. Allowed values are;\n\t\t

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

\n\t\t\tThe DNS query type that the rule you are deleting evaluates. Allowed values are;\n\t\t

\n " } } }, @@ -2173,6 +2179,23 @@ } } }, + "com.amazonaws.route53resolver#FirewallDomainRedirectionAction": { + "type": "enum", + "members": { + "INSPECT_REDIRECTION_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSPECT_REDIRECTION_DOMAIN" + } + }, + "TRUST_REDIRECTION_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRUST_REDIRECTION_DOMAIN" + } + } + } + }, "com.amazonaws.route53resolver#FirewallDomainUpdateOperation": { "type": "enum", "members": { @@ -2300,10 +2323,16 @@ "smithy.api#documentation": "

The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

" } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "

\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t

\n

\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.

\n

\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to \n\t\t\tthe domain alloww list.

" + } + }, "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

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

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

\n " } } }, @@ -8597,10 +8626,16 @@ "smithy.api#documentation": "

The name of the rule.

" } }, + "FirewallDomainRedirectionAction": { + "target": "com.amazonaws.route53resolver#FirewallDomainRedirectionAction", + "traits": { + "smithy.api#documentation": "

\n\t\t\tHow you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. \n\t\t

\n

\n Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be \n\t\t\tadded to the allow domain list.

\n

\n Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to \n\t\t\tthe domain alloww list.

" + } + }, "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

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

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

\n " } } }, diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 16bddfbd6e5..6713e981f03 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -12737,6 +12737,12 @@ "traits": { "smithy.api#documentation": "

Contains information about the infrastructure health check configuration for the training job.

" } + }, + "SessionChainingConfig": { + "target": "com.amazonaws.sagemaker#SessionChainingConfig", + "traits": { + "smithy.api#documentation": "

Contains information about attribute-based access control (ABAC) for the training\n job.

" + } } }, "traits": { @@ -26020,6 +26026,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#EnableSessionTagChaining": { + "type": "boolean" + }, "com.amazonaws.sagemaker#Endpoint": { "type": "structure", "members": { @@ -50484,6 +50493,54 @@ "smithy.api#enumValue": "ml.g5.48xlarge" } }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, "ML_P4D_24XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -57361,6 +57418,20 @@ "smithy.api#documentation": "

Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n

" } }, + "com.amazonaws.sagemaker#SessionChainingConfig": { + "type": "structure", + "members": { + "EnableSessionTagChaining": { + "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", + "traits": { + "smithy.api#documentation": "

Set to True to allow SageMaker to extract session tags from a \n training job creation role and reuse these tags when assuming the training \n job execution role.

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

Contains information about attribute-based access control (ABAC) for a training job.

" + } + }, "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { "type": "integer", "traits": { diff --git a/codegen/sdk/aws-models/signer.json b/codegen/sdk/aws-models/signer.json index e8130694a01..0977eb8bf9a 100644 --- a/codegen/sdk/aws-models/signer.json +++ b/codegen/sdk/aws-models/signer.json @@ -115,7 +115,7 @@ "action": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

The AWS Signer action permitted as part of cross-account permissions.

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

For cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API's operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.

\n\t\t

You can designate the following actions to an account.

\n\t\t ", "smithy.api#required": {} } }, @@ -2677,7 +2677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:

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

You can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.

\n\t\t

For a Java example that shows how to use this action, see StartSigningJob.

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

Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:

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

You can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.

\n\t\t

For a Java example that shows how to use this action, see StartSigningJob.

", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs", From c52540f0e26ce493696ae5f7a8587b5c92ffd4cb Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 30 Apr 2024 18:10:21 +0000 Subject: [PATCH 2/3] chore: release 1.2.2 --- CHANGELOG.md | 17 +++++++++++++++++ gradle.properties | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c782e2f582e..c5ede85d2d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changelog +## [1.2.2] - 04/30/2024 + +### Features +* (**chimesdkvoice**) Due to changes made by the Amazon Alexa service, GetSipMediaApplicationAlexaSkillConfiguration and PutSipMediaApplicationAlexaSkillConfiguration APIs are no longer available for use. For more information, refer to the Alexa Smart Properties page. +* (**codeartifact**) Add support for the Ruby package format. +* (**fms**) AWS Firewall Manager now supports the network firewall service stream exception policy feature for accounts within your organization. +* (**omics**) Add support for workflow sharing and dynamic run storage +* (**opensearch**) This release enables customers to create Route53 A and AAAA alias record types to point custom endpoint domain to OpenSearch domain's dualstack search endpoint. +* (**pinpointsmsvoicev2**) Amazon Pinpoint has added two new features Multimedia services (MMS) and protect configurations. Use the three new MMS APIs to send media messages to a mobile phone which includes image, audio, text, or video files. Use the ten new protect configurations APIs to block messages to specific countries. +* (**qbusiness**) This is a general availability (GA) release of Amazon Q Business. Q Business enables employees in an enterprise to get comprehensive answers to complex questions and take actions through a unified, intuitive web-based chat experience - using an enterprise's existing content, data, and systems. +* (**quicksight**) New Q embedding supporting Generative Q&A +* (**route53resolver**) Release of FirewallDomainRedirectionAction parameter on the Route 53 DNS Firewall Rule. This allows customers to configure a DNS Firewall rule to inspect all the domains in the DNS redirection chain (default) , such as CNAME, ALIAS, DNAME, etc., or just the first domain and trust the rest. +* (**sagemaker**) Amazon SageMaker Training now supports the use of attribute-based access control (ABAC) roles for training job execution roles. Amazon SageMaker Inference now supports G6 instance types. + +### Documentation +* (**signer**) Documentation updates for AWS Signer. Adds cross-account signing constraint and definitions for cross-account actions. + ## [1.2.1] - 04/29/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 2164f2c870e..1910036ba59 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.2.2-SNAPSHOT +sdkVersion=1.2.2 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 23d39f630c179ec5664fd3ee02851416c659b6f5 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 30 Apr 2024 18:10:22 +0000 Subject: [PATCH 3/3] chore: bump snapshot version to 1.2.3-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 1910036ba59..3d8c75ae5bb 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.2.2 +sdkVersion=1.2.3-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/