diff --git a/CHANGELOG.md b/CHANGELOG.md index 25b95ba09f9..af9e69f75be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,21 @@ +Release v1.44.230 (2023-03-27) +=== + +### Service Client Updates +* `service/athena`: Updates service API and documentation + * Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. +* `service/chime-sdk-voice`: Updates service documentation +* `service/connect`: Updates service API and documentation +* `service/connectparticipant`: Updates service documentation +* `service/iotwireless`: Updates service API and documentation +* `service/medialive`: Updates service API and documentation + * AWS Elemental MediaLive now supports ID3 tag insertion for audio only HLS output groups. AWS Elemental Link devices now support tagging. +* `service/sagemaker`: Updates service documentation + * Fixed some improperly rendered links in SDK documentation. +* `service/securityhub`: Updates service API and documentation +* `service/servicecatalog-appregistry`: Updates service API and documentation +* `service/voice-id`: Updates service API, documentation, and paginators + Release v1.44.229 (2023-03-24) === diff --git a/aws/version.go b/aws/version.go index 55e65f65519..e34ec16cb14 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.229" +const SDKVersion = "1.44.230" diff --git a/models/apis/athena/2017-05-18/api-2.json b/models/apis/athena/2017-05-18/api-2.json index 7a1fe3e11e5..d4d55e74922 100644 --- a/models/apis/athena/2017-05-18/api-2.json +++ b/models/apis/athena/2017-05-18/api-2.json @@ -2926,7 +2926,8 @@ "EngineVersion":{"shape":"EngineVersion"}, "AdditionalConfiguration":{"shape":"NameString"}, "ExecutionRole":{"shape":"RoleArn"}, - "CustomerContentEncryptionConfiguration":{"shape":"CustomerContentEncryptionConfiguration"} + "CustomerContentEncryptionConfiguration":{"shape":"CustomerContentEncryptionConfiguration"}, + "EnableMinimumEncryptionConfiguration":{"shape":"BoxedBoolean"} } }, "WorkGroupConfigurationUpdates":{ @@ -2942,7 +2943,8 @@ "RemoveCustomerContentEncryptionConfiguration":{"shape":"BoxedBoolean"}, "AdditionalConfiguration":{"shape":"NameString"}, "ExecutionRole":{"shape":"RoleArn"}, - "CustomerContentEncryptionConfiguration":{"shape":"CustomerContentEncryptionConfiguration"} + "CustomerContentEncryptionConfiguration":{"shape":"CustomerContentEncryptionConfiguration"}, + "EnableMinimumEncryptionConfiguration":{"shape":"BoxedBoolean"} } }, "WorkGroupDescriptionString":{ diff --git a/models/apis/athena/2017-05-18/docs-2.json b/models/apis/athena/2017-05-18/docs-2.json index 69478a53c58..14c721795c0 100644 --- a/models/apis/athena/2017-05-18/docs-2.json +++ b/models/apis/athena/2017-05-18/docs-2.json @@ -9,8 +9,8 @@ "CreateNamedQuery": "

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", "CreateNotebook": "

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

", "CreatePreparedStatement": "

Creates a prepared statement for use with SQL queries in Athena.

", - "CreatePresignedNotebookUrl": "

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token.

", - "CreateWorkGroup": "

Creates a workgroup with the specified name. Only one of Configurations or Configuration can be specified; Configurations for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or Configuration for an Athena SQL workgroup.

", + "CreatePresignedNotebookUrl": "

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

", + "CreateWorkGroup": "

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

", "DeleteDataCatalog": "

Deletes a data catalog.

", "DeleteNamedQuery": "

Deletes the named query if you have access to the workgroup in which the query was saved.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", "DeleteNotebook": "

Deletes the specified notebook.

", @@ -18,7 +18,7 @@ "DeleteWorkGroup": "

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

", "ExportNotebook": "

Exports the specified notebook and its metadata.

", "GetCalculationExecution": "

Describes a previously submitted calculation execution.

", - "GetCalculationExecutionCode": "

Retrieves a pre-signed URL to a copy of the code that was executed for the calculation.

", + "GetCalculationExecutionCode": "

Retrieves the unencrypted code that was executed for the calculation.

", "GetCalculationExecutionStatus": "

Gets the status of a current calculation.

", "GetDataCatalog": "

Returns the specified data catalog.

", "GetDatabase": "

Returns a database object for the specified database and data catalog.

", @@ -26,19 +26,19 @@ "GetNotebookMetadata": "

Retrieves notebook metadata for the specified notebook ID.

", "GetPreparedStatement": "

Retrieves the prepared statement with the specified name from the specified workgroup.

", "GetQueryExecution": "

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

", - "GetQueryResults": "

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

", + "GetQueryResults": "

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

", "GetQueryRuntimeStatistics": "

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.

", "GetSession": "

Gets the full details of a previously created session, including the session status and configuration.

", "GetSessionStatus": "

Gets the current status of a session.

", "GetTableMetadata": "

Returns table metadata for the specified catalog, database, and table.

", "GetWorkGroup": "

Returns information about the workgroup with the specified name.

", "ImportNotebook": "

Imports a single ipynb file to a Spark enabled workgroup. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

", - "ListApplicationDPUSizes": "

Returns the supported DPU sizes for the supported application runtimes (for example, Jupyter 1.0).

", + "ListApplicationDPUSizes": "

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

", "ListCalculationExecutions": "

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

", "ListDataCatalogs": "

Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as \"data sources\" on the Data sources page under the Data source name column.

", "ListDatabases": "

Lists the databases in the specified data catalog.

", "ListEngineVersions": "

Returns a list of engine versions that are available to choose from, including the Auto option.

", - "ListExecutors": "

Lists, in descending order, the executors that have been submitted to a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

", + "ListExecutors": "

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

", "ListNamedQueries": "

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", "ListNotebookMetadata": "

Displays the notebook files for the specified workgroup in paginated format.

", "ListNotebookSessions": "

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

", @@ -48,12 +48,12 @@ "ListTableMetadata": "

Lists the metadata for the tables in the specified data catalog database.

", "ListTagsForResource": "

Lists the tags associated with an Athena workgroup or data catalog resource.

", "ListWorkGroups": "

Lists available workgroups for the account.

", - "StartCalculationExecution": "

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request or as an Amazon S3 URL.

", + "StartCalculationExecution": "

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

", "StartQueryExecution": "

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", "StartSession": "

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

", "StopCalculationExecution": "

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

", "StopQueryExecution": "

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", - "TagResource": "

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

", + "TagResource": "

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

", "TerminateSession": "

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

", "UntagResource": "

Removes one or more tags from a data catalog or workgroup resource.

", "UpdateDataCatalog": "

Updates the data catalog that has the specified name.

", @@ -61,7 +61,7 @@ "UpdateNotebook": "

Updates the contents of a Spark notebook.

", "UpdateNotebookMetadata": "

Updates the metadata for a notebook.

", "UpdatePreparedStatement": "

Updates a prepared statement.

", - "UpdateWorkGroup": "

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only one of ConfigurationsUpdates or ConfigurationUpdates can be specified; ConfigurationsUpdates for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or ConfigurationUpdates for an Athena SQL workgroup.

" + "UpdateWorkGroup": "

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

" }, "shapes": { "AclConfiguration": { @@ -159,7 +159,7 @@ "BoxedBoolean": { "base": null, "refs": { - "DeleteWorkGroupInput$RecursiveDeleteOption": "

The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.

", + "DeleteWorkGroupInput$RecursiveDeleteOption": "

The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.

", "ResultConfigurationUpdates$RemoveOutputLocation": "

If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

", "ResultConfigurationUpdates$RemoveEncryptionConfiguration": "

If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

", "ResultConfigurationUpdates$RemoveExpectedBucketOwner": "

If set to \"true\", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

", @@ -167,11 +167,13 @@ "WorkGroupConfiguration$EnforceWorkGroupConfiguration": "

If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

", "WorkGroupConfiguration$PublishCloudWatchMetricsEnabled": "

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

", "WorkGroupConfiguration$RequesterPaysEnabled": "

If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

", + "WorkGroupConfiguration$EnableMinimumEncryptionConfiguration": "

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

", "WorkGroupConfigurationUpdates$EnforceWorkGroupConfiguration": "

If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

", "WorkGroupConfigurationUpdates$PublishCloudWatchMetricsEnabled": "

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

", "WorkGroupConfigurationUpdates$RemoveBytesScannedCutoffPerQuery": "

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

", "WorkGroupConfigurationUpdates$RequesterPaysEnabled": "

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

", - "WorkGroupConfigurationUpdates$RemoveCustomerContentEncryptionConfiguration": "

Removes content encryption configuration for a workgroup.

" + "WorkGroupConfigurationUpdates$RemoveCustomerContentEncryptionConfiguration": "

Removes content encryption configuration for a workgroup.

", + "WorkGroupConfigurationUpdates$EnableMinimumEncryptionConfiguration": "

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

" } }, "BytesScannedCutoffValue": { @@ -276,7 +278,7 @@ "base": null, "refs": { "CalculationConfiguration$CodeBlock": "

A string that contains the code for the calculation.

", - "GetCalculationExecutionCodeResponse$CodeBlock": "

A pre-signed URL to the code that executed the calculation.

", + "GetCalculationExecutionCodeResponse$CodeBlock": "

The unencrypted code that was executed for the calculation.

", "StartCalculationExecutionRequest$CodeBlock": "

A string that contains the code of the calculation.

" } }, @@ -544,10 +546,10 @@ } }, "EncryptionConfiguration": { - "base": "

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

", + "base": "

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

", "refs": { - "ResultConfiguration$EncryptionConfiguration": "

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

", - "ResultConfigurationUpdates$EncryptionConfiguration": "

The encryption configuration for the query results.

", + "ResultConfiguration$EncryptionConfiguration": "

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

", + "ResultConfigurationUpdates$EncryptionConfiguration": "

The encryption configuration for query and calculation results.

", "SessionConfiguration$EncryptionConfiguration": null } }, @@ -1170,7 +1172,7 @@ "NameString": { "base": null, "refs": { - "ApplicationDPUSizes$ApplicationRuntimeId": "

The name of the supported application runtime (for example, Jupyter 1.0).

", + "ApplicationDPUSizes$ApplicationRuntimeId": "

The name of the supported application runtime (for example, Athena notebook version 1).

", "Column$Name": "

The name of the column.

", "CreateNamedQueryInput$Name": "

The query name.

", "Database$Name": "

The name of the database.

", @@ -1184,7 +1186,7 @@ "ListTableMetadataInput$DatabaseName": "

The name of the database for which table metadata should be returned.

", "NamedQuery$Name": "

The query name.

", "SessionSummary$NotebookVersion": "

The notebook version.

", - "StartSessionRequest$NotebookVersion": "

The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

", + "StartSessionRequest$NotebookVersion": "

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is Athena notebook version 1. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

", "TableMetadata$Name": "

The name of the table.

", "UpdateNamedQueryInput$Name": "

The name of the query.

", "WorkGroupConfiguration$AdditionalConfiguration": "

Specifies a user defined JSON string that is passed to the notebook engine.

", @@ -1236,7 +1238,7 @@ "DeleteNotebookInput$NotebookId": "

The ID of the notebook to delete.

", "ExportNotebookInput$NotebookId": "

The ID of the notebook to export.

", "GetNotebookMetadataInput$NotebookId": "

The ID of the notebook whose metadata is to be retrieved.

", - "ImportNotebookOutput$NotebookId": "

The ID of the notebook to import.

", + "ImportNotebookOutput$NotebookId": "

The ID assigned to the imported notebook.

", "ListNotebookSessionsRequest$NotebookId": "

The ID of the notebook to list sessions for.

", "NotebookMetadata$NotebookId": "

The notebook ID.

", "UpdateNotebookInput$NotebookId": "

The ID of the notebook to update.

", @@ -1293,7 +1295,7 @@ "CreateDataCatalogInput$Parameters": "

Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

", "DataCatalog$Parameters": "

Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.

", "Database$Parameters": "

A set of custom key/value pairs.

", - "EngineConfiguration$AdditionalConfigs": "

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookFileURI to AdditionalConfigs that has value of the Amazon S3 URI.

", + "EngineConfiguration$AdditionalConfigs": "

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

", "TableMetadata$Parameters": "

A set of custom key/value pairs for table properties.

", "UpdateDataCatalogInput$Parameters": "

Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type.

" } @@ -1464,11 +1466,11 @@ } }, "ResultConfiguration": { - "base": "

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.

", + "base": "

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.

", "refs": { - "QueryExecution$ResultConfiguration": "

The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

", + "QueryExecution$ResultConfiguration": "

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

", "StartQueryExecutionInput$ResultConfiguration": "

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", - "WorkGroupConfiguration$ResultConfiguration": "

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

" + "WorkGroupConfiguration$ResultConfiguration": "

The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files.

" } }, "ResultConfigurationUpdates": { @@ -1480,8 +1482,8 @@ "ResultOutputLocation": { "base": null, "refs": { - "ResultConfiguration$OutputLocation": "

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", - "ResultConfigurationUpdates$OutputLocation": "

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", + "ResultConfiguration$OutputLocation": "

The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", + "ResultConfigurationUpdates$OutputLocation": "

The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", "SessionConfiguration$WorkingDirectory": "

The Amazon S3 location that stores information for the notebook.

" } }, @@ -1520,7 +1522,7 @@ "base": null, "refs": { "SessionConfiguration$ExecutionRole": "

The ARN of the execution role used for the session.

", - "WorkGroupConfiguration$ExecutionRole": "

Role used in a notebook session for accessing the user's resources.

", + "WorkGroupConfiguration$ExecutionRole": "

Role used in a session for accessing the user's resources.

", "WorkGroupConfigurationUpdates$ExecutionRole": "

Contains the ARN of the execution role for the workgroup

" } }, @@ -1579,7 +1581,7 @@ "StartCalculationExecutionRequest$SessionId": "

The session ID.

", "StartSessionResponse$SessionId": "

The session ID.

", "TerminateSessionRequest$SessionId": "

The session ID.

", - "UpdateNotebookInput$SessionId": "

The ID of the session in which the notebook will be updated.

" + "UpdateNotebookInput$SessionId": "

The active notebook session ID. Required if the notebook has an active session.

" } }, "SessionIdleTimeoutInMinutes": { @@ -1609,13 +1611,13 @@ } }, "SessionStatistics": { - "base": "

Contains statistics for a notebook session.

", + "base": "

Contains statistics for a session.

", "refs": { "GetSessionResponse$Statistics": "

Contains the DPU execution time.

" } }, "SessionStatus": { - "base": "

Contains information about the status of a notebook session.

", + "base": "

Contains information about the status of a session.

", "refs": { "GetSessionResponse$Status": "

Contains information about the status of the session.

", "GetSessionStatusResponse$Status": "

Contains information about the status of the session.

", @@ -1623,7 +1625,7 @@ } }, "SessionSummary": { - "base": "

Contains summary information about a notebook session.

", + "base": "

Contains summary information about a session.

", "refs": { "SessionsList$member": null } @@ -1756,7 +1758,7 @@ } }, "Tag": { - "base": "

A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

", + "base": "

A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

", "refs": { "TagList$member": null } @@ -1977,14 +1979,14 @@ } }, "WorkGroupConfiguration": { - "base": "

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", + "base": "

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", "refs": { - "CreateWorkGroupInput$Configuration": "

Contains configuration information for creating an Athena SQL workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", - "WorkGroup$Configuration": "

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "CreateWorkGroupInput$Configuration": "

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

", + "WorkGroup$Configuration": "

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "WorkGroupConfigurationUpdates": { - "base": "

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

", + "base": "

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

", "refs": { "UpdateWorkGroupInput$ConfigurationUpdates": "

Contains configuration updates for an Athena SQL workgroup.

" } diff --git a/models/apis/chime-sdk-voice/2022-08-03/docs-2.json b/models/apis/chime-sdk-voice/2022-08-03/docs-2.json index 975c549996e..5d2f26af0da 100644 --- a/models/apis/chime-sdk-voice/2022-08-03/docs-2.json +++ b/models/apis/chime-sdk-voice/2022-08-03/docs-2.json @@ -1,111 +1,111 @@ { "version": "2.0", - "service": null, + "service": "

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

", "operations": { - "AssociatePhoneNumbersWithVoiceConnector": null, - "AssociatePhoneNumbersWithVoiceConnectorGroup": null, - "BatchDeletePhoneNumber": null, - "BatchUpdatePhoneNumber": null, - "CreatePhoneNumberOrder": null, - "CreateProxySession": null, - "CreateSipMediaApplication": null, - "CreateSipMediaApplicationCall": null, - "CreateSipRule": null, - "CreateVoiceConnector": null, - "CreateVoiceConnectorGroup": null, - "CreateVoiceProfile": null, - "CreateVoiceProfileDomain": null, - "DeletePhoneNumber": null, - "DeleteProxySession": null, - "DeleteSipMediaApplication": null, - "DeleteSipRule": null, - "DeleteVoiceConnector": null, - "DeleteVoiceConnectorEmergencyCallingConfiguration": null, - "DeleteVoiceConnectorGroup": null, - "DeleteVoiceConnectorOrigination": null, - "DeleteVoiceConnectorProxy": null, - "DeleteVoiceConnectorStreamingConfiguration": null, - "DeleteVoiceConnectorTermination": null, - "DeleteVoiceConnectorTerminationCredentials": null, - "DeleteVoiceProfile": null, - "DeleteVoiceProfileDomain": null, - "DisassociatePhoneNumbersFromVoiceConnector": null, - "DisassociatePhoneNumbersFromVoiceConnectorGroup": null, - "GetGlobalSettings": null, - "GetPhoneNumber": null, - "GetPhoneNumberOrder": null, - "GetPhoneNumberSettings": null, - "GetProxySession": null, - "GetSipMediaApplication": null, - "GetSipMediaApplicationAlexaSkillConfiguration": null, - "GetSipMediaApplicationLoggingConfiguration": null, - "GetSipRule": null, - "GetSpeakerSearchTask": null, - "GetVoiceConnector": null, - "GetVoiceConnectorEmergencyCallingConfiguration": null, - "GetVoiceConnectorGroup": null, - "GetVoiceConnectorLoggingConfiguration": null, - "GetVoiceConnectorOrigination": null, - "GetVoiceConnectorProxy": null, - "GetVoiceConnectorStreamingConfiguration": null, - "GetVoiceConnectorTermination": null, - "GetVoiceConnectorTerminationHealth": null, - "GetVoiceProfile": null, - "GetVoiceProfileDomain": null, - "GetVoiceToneAnalysisTask": null, - "ListAvailableVoiceConnectorRegions": null, - "ListPhoneNumberOrders": null, - "ListPhoneNumbers": null, - "ListProxySessions": null, - "ListSipMediaApplications": null, - "ListSipRules": null, - "ListSupportedPhoneNumberCountries": null, - "ListTagsForResource": null, - "ListVoiceConnectorGroups": null, - "ListVoiceConnectorTerminationCredentials": null, - "ListVoiceConnectors": null, - "ListVoiceProfileDomains": null, - "ListVoiceProfiles": null, - "PutSipMediaApplicationAlexaSkillConfiguration": null, - "PutSipMediaApplicationLoggingConfiguration": null, - "PutVoiceConnectorEmergencyCallingConfiguration": null, - "PutVoiceConnectorLoggingConfiguration": null, - "PutVoiceConnectorOrigination": null, - "PutVoiceConnectorProxy": null, - "PutVoiceConnectorStreamingConfiguration": null, - "PutVoiceConnectorTermination": null, - "PutVoiceConnectorTerminationCredentials": null, - "RestorePhoneNumber": null, - "SearchAvailablePhoneNumbers": null, - "StartSpeakerSearchTask": null, - "StartVoiceToneAnalysisTask": null, - "StopSpeakerSearchTask": null, - "StopVoiceToneAnalysisTask": null, - "TagResource": null, - "UntagResource": null, - "UpdateGlobalSettings": null, - "UpdatePhoneNumber": null, - "UpdatePhoneNumberSettings": null, - "UpdateProxySession": null, - "UpdateSipMediaApplication": null, - "UpdateSipMediaApplicationCall": null, - "UpdateSipRule": null, - "UpdateVoiceConnector": null, - "UpdateVoiceConnectorGroup": null, - "UpdateVoiceProfile": null, - "UpdateVoiceProfileDomain": null, - "ValidateE911Address": null + "AssociatePhoneNumbersWithVoiceConnector": "

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

", + "AssociatePhoneNumbersWithVoiceConnectorGroup": "

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

", + "BatchDeletePhoneNumber": "

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

", + "BatchUpdatePhoneNumber": "

Updates one or more phone numbers.

", + "CreatePhoneNumberOrder": "

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

", + "CreateProxySession": "

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

", + "CreateSipMediaApplication": "

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

", + "CreateSipMediaApplicationCall": "

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

", + "CreateSipRule": "

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

", + "CreateVoiceConnector": "

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

", + "CreateVoiceConnectorGroup": "

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

", + "CreateVoiceProfile": "

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

", + "CreateVoiceProfileDomain": "

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

", + "DeletePhoneNumber": "

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

", + "DeleteProxySession": "

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

", + "DeleteSipMediaApplication": "

Deletes a SIP media application.

", + "DeleteSipRule": "

Deletes a SIP rule.

", + "DeleteVoiceConnector": "

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

", + "DeleteVoiceConnectorEmergencyCallingConfiguration": "

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

", + "DeleteVoiceConnectorGroup": "

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

", + "DeleteVoiceConnectorOrigination": "

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

", + "DeleteVoiceConnectorProxy": "

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

", + "DeleteVoiceConnectorStreamingConfiguration": "

Deletes a Voice Connector's streaming configuration.

", + "DeleteVoiceConnectorTermination": "

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

", + "DeleteVoiceConnectorTerminationCredentials": "

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

", + "DeleteVoiceProfile": "

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

", + "DeleteVoiceProfileDomain": "

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

", + "DisassociatePhoneNumbersFromVoiceConnector": "

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

", + "DisassociatePhoneNumbersFromVoiceConnectorGroup": "

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

", + "GetGlobalSettings": "

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

", + "GetPhoneNumber": "

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

", + "GetPhoneNumberOrder": "

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

", + "GetPhoneNumberSettings": "

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

", + "GetProxySession": "

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

", + "GetSipMediaApplication": "

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

", + "GetSipMediaApplicationAlexaSkillConfiguration": "

Gets the Alexa Skill configuration for the SIP media application.

", + "GetSipMediaApplicationLoggingConfiguration": "

Retrieves the logging configuration for the specified SIP media application.

", + "GetSipRule": "

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

", + "GetSpeakerSearchTask": "

Retrieves the details of the specified speaker search task.

", + "GetVoiceConnector": "

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

", + "GetVoiceConnectorEmergencyCallingConfiguration": "

Retrieves the emergency calling configuration details for the specified Voice Connector.

", + "GetVoiceConnectorGroup": "

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

", + "GetVoiceConnectorLoggingConfiguration": "

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

", + "GetVoiceConnectorOrigination": "

Retrieves the origination settings for the specified Voice Connector.

", + "GetVoiceConnectorProxy": "

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

", + "GetVoiceConnectorStreamingConfiguration": "

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

", + "GetVoiceConnectorTermination": "

Retrieves the termination setting details for the specified Voice Connector.

", + "GetVoiceConnectorTerminationHealth": "

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

", + "GetVoiceProfile": "

Retrieves the details of the specified voice profile.

", + "GetVoiceProfileDomain": "

Retrieves the details of the specified voice profile domain.

", + "GetVoiceToneAnalysisTask": "

Retrieves the details of a voice tone analysis task.

", + "ListAvailableVoiceConnectorRegions": "

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

", + "ListPhoneNumberOrders": "

Lists the phone numbers for an administrator's Amazon Chime SDK account.

", + "ListPhoneNumbers": "

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

", + "ListProxySessions": "

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

", + "ListSipMediaApplications": "

Lists the SIP media applications under the administrator's AWS account.

", + "ListSipRules": "

Lists the SIP rules under the administrator's AWS account.

", + "ListSupportedPhoneNumberCountries": "

Lists the countries that you can order phone numbers from.

", + "ListTagsForResource": "

Returns a list of the tags in a given resource.

", + "ListVoiceConnectorGroups": "

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

", + "ListVoiceConnectorTerminationCredentials": "

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

", + "ListVoiceConnectors": "

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

", + "ListVoiceProfileDomains": "

Lists the specified voice profile domains in the administrator's AWS account.

", + "ListVoiceProfiles": "

Lists the voice profiles in a voice profile domain.

", + "PutSipMediaApplicationAlexaSkillConfiguration": "

Updates the Alexa Skill configuration for the SIP media application.

", + "PutSipMediaApplicationLoggingConfiguration": "

Updates the logging configuration for the specified SIP media application.

", + "PutVoiceConnectorEmergencyCallingConfiguration": "

Updates a Voice Connector's emergency calling configuration.

", + "PutVoiceConnectorLoggingConfiguration": "

Updates a Voice Connector's logging configuration.

", + "PutVoiceConnectorOrigination": "

Updates a Voice Connector's origination settings.

", + "PutVoiceConnectorProxy": "

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

", + "PutVoiceConnectorStreamingConfiguration": "

Updates a Voice Connector's streaming configuration settings.

", + "PutVoiceConnectorTermination": "

Updates a Voice Connector's termination settings.

", + "PutVoiceConnectorTerminationCredentials": "

Updates a Voice Connector's termination credentials.

", + "RestorePhoneNumber": "

Restores a deleted phone number.

", + "SearchAvailablePhoneNumbers": "

Searches the provisioned phone numbers in an organization.

", + "StartSpeakerSearchTask": "

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

", + "StartVoiceToneAnalysisTask": "

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

", + "StopSpeakerSearchTask": "

Stops a speaker search task.

", + "StopVoiceToneAnalysisTask": "

Stops a voice tone analysis task.

", + "TagResource": "

Adds a tag to the specified resource.

", + "UntagResource": "

Removes tags from a resource.

", + "UpdateGlobalSettings": "

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

", + "UpdatePhoneNumber": "

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

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

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

", + "UpdatePhoneNumberSettings": "

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

", + "UpdateProxySession": "

Updates the specified proxy session details, such as voice or SMS capabilities.

", + "UpdateSipMediaApplication": "

Updates the details of the specified SIP media application.

", + "UpdateSipMediaApplicationCall": "

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

", + "UpdateSipRule": "

Updates the details of the specified SIP rule.

", + "UpdateVoiceConnector": "

Updates the details for the specified Amazon Chime SDK Voice Connector.

", + "UpdateVoiceConnectorGroup": "

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

", + "UpdateVoiceProfile": "

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

", + "UpdateVoiceProfileDomain": "

Updates the settings for the specified voice profile domain.

", + "ValidateE911Address": "

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

" }, "shapes": { "AccessDeniedException": { - "base": null, + "base": "

You don't have the permissions needed to run this action.

", "refs": { } }, "Address": { - "base": null, + "base": "

A validated address.

", "refs": { - "ValidateE911AddressResponse$Address": null + "ValidateE911AddressResponse$Address": "

The validated address.

" } }, "AlexaSkillId": { @@ -117,42 +117,42 @@ "AlexaSkillIdList": { "base": null, "refs": { - "SipMediaApplicationAlexaSkillConfiguration$AlexaSkillIds": null + "SipMediaApplicationAlexaSkillConfiguration$AlexaSkillIds": "

The ID of the Alexa Skill configuration.

" } }, "AlexaSkillStatus": { "base": null, "refs": { - "SipMediaApplicationAlexaSkillConfiguration$AlexaSkillStatus": null + "SipMediaApplicationAlexaSkillConfiguration$AlexaSkillStatus": "

The status of the Alexa Skill configuration.

" } }, "Alpha2CountryCode": { "base": null, "refs": { - "DNISEmergencyCallingConfiguration$CallingCountry": null, - "PhoneNumber$Country": null, - "PhoneNumberCountry$CountryCode": null, - "SearchAvailablePhoneNumbersRequest$Country": null + "DNISEmergencyCallingConfiguration$CallingCountry": "

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

", + "PhoneNumber$Country": "

The phone number's country. Format: ISO 3166-1 alpha-2.

", + "PhoneNumberCountry$CountryCode": "

The phone number country code. Format: ISO 3166-1 alpha-2.

", + "SearchAvailablePhoneNumbersRequest$Country": "

Confines a search to just the phone numbers associated with the specified country.

" } }, "AreaCode": { "base": null, "refs": { - "GeoMatchParams$AreaCode": null + "GeoMatchParams$AreaCode": "

The area code.

" } }, "Arn": { "base": null, "refs": { - "ListTagsForResourceRequest$ResourceARN": null, - "MediaInsightsConfiguration$ConfigurationArn": null, - "ServerSideEncryptionConfiguration$KmsKeyArn": null, - "TagResourceRequest$ResourceARN": null, - "UntagResourceRequest$ResourceARN": null, - "VoiceProfile$VoiceProfileArn": null, - "VoiceProfileDomain$VoiceProfileDomainArn": null, - "VoiceProfileDomainSummary$VoiceProfileDomainArn": null, - "VoiceProfileSummary$VoiceProfileArn": null + "ListTagsForResourceRequest$ResourceARN": "

The resource ARN.

", + "MediaInsightsConfiguration$ConfigurationArn": "

The configuration's ARN.

", + "ServerSideEncryptionConfiguration$KmsKeyArn": "

The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

", + "TagResourceRequest$ResourceARN": "

The ARN of the resource being tagged.

", + "UntagResourceRequest$ResourceARN": "

The ARN of the resource having its tags removed.

", + "VoiceProfile$VoiceProfileArn": "

The ARN of the voice profile.

", + "VoiceProfileDomain$VoiceProfileDomainArn": "

The voice profile domain's Amazon Resource Number (ARN).

", + "VoiceProfileDomainSummary$VoiceProfileDomainArn": "

The ARN of a voice profile in a voice profile domain summary.

", + "VoiceProfileSummary$VoiceProfileArn": "

The ARN of the voice profile in a voice profile summary.

" } }, "AssociatePhoneNumbersWithVoiceConnectorGroupRequest": { @@ -176,7 +176,7 @@ } }, "BadRequestException": { - "base": null, + "base": "

The input parameters don't match the service's restrictions.

", "refs": { } }, @@ -203,44 +203,44 @@ "Boolean": { "base": null, "refs": { - "CallDetails$IsCaller": null, - "CreateVoiceConnectorRequest$RequireEncryption": null, - "GetVoiceToneAnalysisTaskRequest$IsCaller": null, - "LoggingConfiguration$EnableSIPLogs": null, - "LoggingConfiguration$EnableMediaMetricLogs": null, - "MediaInsightsConfiguration$Disabled": null, - "Origination$Disabled": null, - "Proxy$Disabled": null, - "PutVoiceConnectorProxyRequest$Disabled": null, - "SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs": null, - "SipRule$Disabled": null, - "StreamingConfiguration$Disabled": null, - "Termination$Disabled": null, - "UpdateVoiceConnectorRequest$RequireEncryption": null, - "VoiceConnector$RequireEncryption": null + "CallDetails$IsCaller": "

Identifies a person as the caller or the callee.

", + "CreateVoiceConnectorRequest$RequireEncryption": "

Enables or disables encryption for the Voice Connector.

", + "GetVoiceToneAnalysisTaskRequest$IsCaller": "

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

", + "LoggingConfiguration$EnableSIPLogs": "

Boolean that enables sending SIP message logs to Amazon CloudWatch logs.

", + "LoggingConfiguration$EnableMediaMetricLogs": "

Enables or disables media metrics logging.

", + "MediaInsightsConfiguration$Disabled": "

Denotes the configration as enabled or disabled.

", + "Origination$Disabled": "

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

", + "Proxy$Disabled": "

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

", + "PutVoiceConnectorProxyRequest$Disabled": "

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

", + "SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs": "

Enables message logging for the specified SIP media application.

", + "SipRule$Disabled": "

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

", + "StreamingConfiguration$Disabled": "

When true, streaming to Kinesis is off.

", + "Termination$Disabled": "

When termination is disabled, outbound calls cannot be made.

", + "UpdateVoiceConnectorRequest$RequireEncryption": "

When enabled, requires encryption for the Voice Connector.

", + "VoiceConnector$RequireEncryption": "

Enables or disables encryption for the Voice Connector.

" } }, "CallDetails": { - "base": null, + "base": "

The details of an Amazon Chime SDK Voice Connector call.

", "refs": { - "SpeakerSearchTask$CallDetails": null, - "VoiceToneAnalysisTask$CallDetails": null + "SpeakerSearchTask$CallDetails": "

The call details of a speaker search task.

", + "VoiceToneAnalysisTask$CallDetails": "

The call details of a voice tone analysis task.

" } }, "CallingName": { "base": null, "refs": { - "GetPhoneNumberSettingsResponse$CallingName": null, - "PhoneNumber$CallingName": null, - "UpdatePhoneNumberRequest$CallingName": null, - "UpdatePhoneNumberRequestItem$CallingName": null, - "UpdatePhoneNumberSettingsRequest$CallingName": null + "GetPhoneNumberSettingsResponse$CallingName": "

The default outbound calling name for the account.

", + "PhoneNumber$CallingName": "

The outbound calling name associated with the phone number.

", + "UpdatePhoneNumberRequest$CallingName": "

The outbound calling name associated with the phone number.

", + "UpdatePhoneNumberRequestItem$CallingName": "

The outbound calling name to update.

", + "UpdatePhoneNumberSettingsRequest$CallingName": "

The default outbound calling name for the account.

" } }, "CallingNameStatus": { "base": null, "refs": { - "PhoneNumber$CallingNameStatus": null + "PhoneNumber$CallingNameStatus": "

The outbound calling name status.

" } }, "CallingRegion": { @@ -252,11 +252,11 @@ "CallingRegionList": { "base": null, "refs": { - "Termination$CallingRegions": null + "Termination$CallingRegions": "

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

" } }, "CandidateAddress": { - "base": null, + "base": "

A suggested address.

", "refs": { "CandidateAddressList$member": null } @@ -264,7 +264,7 @@ "CandidateAddressList": { "base": null, "refs": { - "ValidateE911AddressResponse$CandidateAddressList": null + "ValidateE911AddressResponse$CandidateAddressList": "

The list of address suggestions..

" } }, "Capability": { @@ -276,27 +276,27 @@ "CapabilityList": { "base": null, "refs": { - "CreateProxySessionRequest$Capabilities": null, - "ProxySession$Capabilities": null, - "UpdateProxySessionRequest$Capabilities": null + "CreateProxySessionRequest$Capabilities": "

The proxy session's capabilities.

", + "ProxySession$Capabilities": "

The proxy session capabilities.

", + "UpdateProxySessionRequest$Capabilities": "

The proxy session capabilities.

" } }, "ClientRequestId": { "base": null, "refs": { - "CreateVoiceProfileDomainRequest$ClientRequestToken": null, - "StartSpeakerSearchTaskRequest$ClientRequestToken": null, - "StartVoiceToneAnalysisTaskRequest$ClientRequestToken": null + "CreateVoiceProfileDomainRequest$ClientRequestToken": "

The unique identifier for the client request. Use a different token for different domain creation requests.

", + "StartSpeakerSearchTaskRequest$ClientRequestToken": "

The unique identifier for the client request. Use a different token for different speaker search tasks.

", + "StartVoiceToneAnalysisTaskRequest$ClientRequestToken": "

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

" } }, "ConfidenceScore": { "base": null, "refs": { - "SpeakerSearchResult$ConfidenceScore": null + "SpeakerSearchResult$ConfidenceScore": "

The confidence score in the speaker search analysis.

" } }, "ConflictException": { - "base": null, + "base": "

Multiple instances of the same request were made simultaneously.

", "refs": { } }, @@ -304,19 +304,19 @@ "base": null, "refs": { "CountryList$member": null, - "GeoMatchParams$Country": null + "GeoMatchParams$Country": "

The country.

" } }, "CountryList": { "base": null, "refs": { - "PutVoiceConnectorProxyRequest$PhoneNumberPoolCountries": null + "PutVoiceConnectorProxyRequest$PhoneNumberPoolCountries": "

The countries for proxy phone numbers to be selected from.

" } }, "CpsLimit": { "base": null, "refs": { - "Termination$CpsLimit": null + "Termination$CpsLimit": "

The limit on calls per second. Max value based on account service quota. Default value of 1.

" } }, "CreatePhoneNumberOrderRequest": { @@ -410,7 +410,7 @@ } }, "Credential": { - "base": null, + "base": "

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

", "refs": { "CredentialList$member": null } @@ -418,11 +418,11 @@ "CredentialList": { "base": null, "refs": { - "PutVoiceConnectorTerminationCredentialsRequest$Credentials": null + "PutVoiceConnectorTerminationCredentialsRequest$Credentials": "

The termination credentials being updated.

" } }, "DNISEmergencyCallingConfiguration": { - "base": null, + "base": "

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration.

", "refs": { "DNISEmergencyCallingConfigurationList$member": null } @@ -430,13 +430,13 @@ "DNISEmergencyCallingConfigurationList": { "base": null, "refs": { - "EmergencyCallingConfiguration$DNIS": null + "EmergencyCallingConfiguration$DNIS": "

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

" } }, "DataRetentionInHours": { "base": null, "refs": { - "StreamingConfiguration$DataRetentionInHours": null + "StreamingConfiguration$DataRetentionInHours": "

The amount of time, in hours, to the Kinesis data.

" } }, "DeletePhoneNumberRequest": { @@ -532,69 +532,69 @@ "E164PhoneNumber": { "base": null, "refs": { - "CreateSipMediaApplicationCallRequest$FromPhoneNumber": null, - "CreateSipMediaApplicationCallRequest$ToPhoneNumber": null, - "DNISEmergencyCallingConfiguration$EmergencyPhoneNumber": null, - "DNISEmergencyCallingConfiguration$TestPhoneNumber": null, + "CreateSipMediaApplicationCallRequest$FromPhoneNumber": "

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

", + "CreateSipMediaApplicationCallRequest$ToPhoneNumber": "

The phone number that the service should call.

", + "DNISEmergencyCallingConfiguration$EmergencyPhoneNumber": "

The DNIS phone number that you route emergency calls to, in E.164 format.

", + "DNISEmergencyCallingConfiguration$TestPhoneNumber": "

The DNIS phone number for routing test emergency calls to, in E.164 format.

", "E164PhoneNumberList$member": null, - "OrderedPhoneNumber$E164PhoneNumber": null, - "Participant$PhoneNumber": null, - "Participant$ProxyPhoneNumber": null, + "OrderedPhoneNumber$E164PhoneNumber": "

The phone number, in E.164 format.

", + "Participant$PhoneNumber": "

The participant's phone number.

", + "Participant$ProxyPhoneNumber": "

The participant's proxy phone number.

", "ParticipantPhoneNumberList$member": null, - "PhoneNumber$E164PhoneNumber": null, - "Proxy$FallBackPhoneNumber": null, - "PutVoiceConnectorProxyRequest$FallBackPhoneNumber": null, - "Termination$DefaultPhoneNumber": null + "PhoneNumber$E164PhoneNumber": "

The phone number, in E.164 format.

", + "Proxy$FallBackPhoneNumber": "

The phone number to route calls to after a proxy session expires.

", + "PutVoiceConnectorProxyRequest$FallBackPhoneNumber": "

The phone number to route calls to after a proxy session expires.

", + "Termination$DefaultPhoneNumber": "

The default outbound calling number.

" } }, "E164PhoneNumberList": { "base": null, "refs": { - "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$E164PhoneNumbers": null, - "AssociatePhoneNumbersWithVoiceConnectorRequest$E164PhoneNumbers": null, - "CreatePhoneNumberOrderRequest$E164PhoneNumbers": null, - "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$E164PhoneNumbers": null, - "DisassociatePhoneNumbersFromVoiceConnectorRequest$E164PhoneNumbers": null, - "SearchAvailablePhoneNumbersResponse$E164PhoneNumbers": null + "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$E164PhoneNumbers": "

List of phone numbers, in E.164 format.

", + "AssociatePhoneNumbersWithVoiceConnectorRequest$E164PhoneNumbers": "

List of phone numbers, in E.164 format.

", + "CreatePhoneNumberOrderRequest$E164PhoneNumbers": "

List of phone numbers, in E.164 format.

", + "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$E164PhoneNumbers": "

The list of phone numbers, in E.164 format.

", + "DisassociatePhoneNumbersFromVoiceConnectorRequest$E164PhoneNumbers": "

List of phone numbers, in E.164 format.

", + "SearchAvailablePhoneNumbersResponse$E164PhoneNumbers": "

Confines a search to just the phone numbers in the E.164 format.

" } }, "EmergencyCallingConfiguration": { - "base": null, + "base": "

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

", "refs": { - "GetVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration": null, - "PutVoiceConnectorEmergencyCallingConfigurationRequest$EmergencyCallingConfiguration": null, - "PutVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration": null + "GetVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration": "

The details of the emergency calling configuration.

", + "PutVoiceConnectorEmergencyCallingConfigurationRequest$EmergencyCallingConfiguration": "

The configuration being updated.

", + "PutVoiceConnectorEmergencyCallingConfigurationResponse$EmergencyCallingConfiguration": "

The updated configuration.

" } }, "ErrorCode": { "base": null, "refs": { - "PhoneNumberError$ErrorCode": null + "PhoneNumberError$ErrorCode": "

The error code.

" } }, "ForbiddenException": { - "base": null, + "base": "

The client is permanently forbidden from making the request.

", "refs": { } }, "FunctionArn": { "base": null, "refs": { - "SipMediaApplicationEndpoint$LambdaArn": null + "SipMediaApplicationEndpoint$LambdaArn": "

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

" } }, "GeoMatchLevel": { "base": null, "refs": { - "CreateProxySessionRequest$GeoMatchLevel": null, - "ProxySession$GeoMatchLevel": null + "CreateProxySessionRequest$GeoMatchLevel": "

The preference for matching the country or area code of the proxy phone number with that of the first participant.

", + "ProxySession$GeoMatchLevel": "

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" } }, "GeoMatchParams": { - "base": null, + "base": "

The country and area code for a proxy phone number in a proxy phone session.

", "refs": { - "CreateProxySessionRequest$GeoMatchParams": null, - "ProxySession$GeoMatchParams": null + "CreateProxySessionRequest$GeoMatchParams": "

The country and area code for the proxy phone number.

", + "ProxySession$GeoMatchParams": "

The country and area code for the proxy phone number.

" } }, "GetGlobalSettingsResponse": { @@ -808,70 +808,70 @@ } }, "GoneException": { - "base": null, + "base": "

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

", "refs": { } }, "GuidString": { "base": null, "refs": { - "GetPhoneNumberOrderRequest$PhoneNumberOrderId": null, - "PhoneNumber$OrderId": null, - "PhoneNumberOrder$PhoneNumberOrderId": null, - "SipMediaApplicationCall$TransactionId": null + "GetPhoneNumberOrderRequest$PhoneNumberOrderId": "

The ID of the phone number order .

", + "PhoneNumber$OrderId": "

The phone number's order ID.

", + "PhoneNumberOrder$PhoneNumberOrderId": "

The ID of the phone order.

", + "SipMediaApplicationCall$TransactionId": "

The call's transaction ID.

" } }, "Integer": { "base": null, "refs": { - "Proxy$DefaultSessionExpiryMinutes": null, - "PutVoiceConnectorProxyRequest$DefaultSessionExpiryMinutes": null + "Proxy$DefaultSessionExpiryMinutes": "

The default number of minutes allowed for proxy sessions.

", + "PutVoiceConnectorProxyRequest$DefaultSessionExpiryMinutes": "

The default number of minutes allowed for proxy session.

" } }, "Iso8601Timestamp": { "base": null, "refs": { - "GetPhoneNumberSettingsResponse$CallingNameUpdatedTimestamp": null, - "PhoneNumber$CreatedTimestamp": null, - "PhoneNumber$UpdatedTimestamp": null, - "PhoneNumber$DeletionTimestamp": null, - "PhoneNumberAssociation$AssociatedTimestamp": null, - "PhoneNumberOrder$CreatedTimestamp": null, - "PhoneNumberOrder$UpdatedTimestamp": null, - "ProxySession$CreatedTimestamp": null, - "ProxySession$UpdatedTimestamp": null, - "ProxySession$EndedTimestamp": null, - "SipMediaApplication$CreatedTimestamp": null, - "SipMediaApplication$UpdatedTimestamp": null, - "SipRule$CreatedTimestamp": null, - "SipRule$UpdatedTimestamp": null, - "SpeakerSearchTask$CreatedTimestamp": null, - "SpeakerSearchTask$UpdatedTimestamp": null, - "SpeakerSearchTask$StartedTimestamp": null, - "TerminationHealth$Timestamp": null, - "VoiceConnector$CreatedTimestamp": null, - "VoiceConnector$UpdatedTimestamp": null, - "VoiceConnectorGroup$CreatedTimestamp": null, - "VoiceConnectorGroup$UpdatedTimestamp": null, - "VoiceProfile$CreatedTimestamp": null, - "VoiceProfile$UpdatedTimestamp": null, - "VoiceProfile$ExpirationTimestamp": null, - "VoiceProfileDomain$CreatedTimestamp": null, - "VoiceProfileDomain$UpdatedTimestamp": null, - "VoiceProfileDomainSummary$CreatedTimestamp": null, - "VoiceProfileDomainSummary$UpdatedTimestamp": null, - "VoiceProfileSummary$CreatedTimestamp": null, - "VoiceProfileSummary$UpdatedTimestamp": null, - "VoiceProfileSummary$ExpirationTimestamp": null, - "VoiceToneAnalysisTask$CreatedTimestamp": null, - "VoiceToneAnalysisTask$UpdatedTimestamp": null, - "VoiceToneAnalysisTask$StartedTimestamp": null + "GetPhoneNumberSettingsResponse$CallingNameUpdatedTimestamp": "

The updated outbound calling name timestamp, in ISO 8601 format.

", + "PhoneNumber$CreatedTimestamp": "

The phone number creation timestamp, in ISO 8601 format.

", + "PhoneNumber$UpdatedTimestamp": "

The updated phone number timestamp, in ISO 8601 format.

", + "PhoneNumber$DeletionTimestamp": "

The deleted phone number timestamp, in ISO 8601 format.

", + "PhoneNumberAssociation$AssociatedTimestamp": "

The timestamp of the phone number association, in ISO 8601 format.

", + "PhoneNumberOrder$CreatedTimestamp": "

The phone number order creation time stamp, in ISO 8601 format.

", + "PhoneNumberOrder$UpdatedTimestamp": "

The updated phone number order time stamp, in ISO 8601 format.

", + "ProxySession$CreatedTimestamp": "

The created time stamp, in ISO 8601 format.

", + "ProxySession$UpdatedTimestamp": "

The updated time stamp, in ISO 8601 format.

", + "ProxySession$EndedTimestamp": "

The ended time stamp, in ISO 8601 format.

", + "SipMediaApplication$CreatedTimestamp": "

The SIP media application creation timestamp, in ISO 8601 format.

", + "SipMediaApplication$UpdatedTimestamp": "

The time at which the SIP media application was updated.

", + "SipRule$CreatedTimestamp": "

The time at which the SIP rule was created, in ISO 8601 format.

", + "SipRule$UpdatedTimestamp": "

The time at which the SIP rule was updated, in ISO 8601 format.

", + "SpeakerSearchTask$CreatedTimestamp": "

The time at which a speaker search task was created.

", + "SpeakerSearchTask$UpdatedTimestamp": "

The time at which a speaker search task was updated.

", + "SpeakerSearchTask$StartedTimestamp": "

The time at which the speaker search task began.

", + "TerminationHealth$Timestamp": "

The timestamp, in ISO 8601 format.

", + "VoiceConnector$CreatedTimestamp": "

The Voice Connector's creation timestamp, in ISO 8601 format.

", + "VoiceConnector$UpdatedTimestamp": "

The Voice Connector's updated timestamp, in ISO 8601 format.

", + "VoiceConnectorGroup$CreatedTimestamp": "

The Voice Connector group's creation time stamp, in ISO 8601 format.

", + "VoiceConnectorGroup$UpdatedTimestamp": "

The Voice Connector group's creation time stamp, in ISO 8601 format.

", + "VoiceProfile$CreatedTimestamp": "

The time at which the voice profile was created and enrolled.

", + "VoiceProfile$UpdatedTimestamp": "

The time at which the voice profile was last updated.

", + "VoiceProfile$ExpirationTimestamp": "

The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

", + "VoiceProfileDomain$CreatedTimestamp": "

The time at which the voice profile domain was created.

", + "VoiceProfileDomain$UpdatedTimestamp": "

The time at which the voice profile was last updated.

", + "VoiceProfileDomainSummary$CreatedTimestamp": "

The time at which the voice profile domain summary was created.

", + "VoiceProfileDomainSummary$UpdatedTimestamp": "

The time at which the voice profile domain summary was last updated.

", + "VoiceProfileSummary$CreatedTimestamp": "

The time at which a voice profile summary was created.

", + "VoiceProfileSummary$UpdatedTimestamp": "

The time at which a voice profile summary was last updated.

", + "VoiceProfileSummary$ExpirationTimestamp": "

Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile's voice print and extend the life of the summary.

", + "VoiceToneAnalysisTask$CreatedTimestamp": "

The time at which a voice tone analysis task was created.

", + "VoiceToneAnalysisTask$UpdatedTimestamp": "

The time at which a voice tone analysis task was updated.

", + "VoiceToneAnalysisTask$StartedTimestamp": "

The time at which a voice tone analysis task started.

" } }, "LanguageCode": { "base": null, "refs": { - "StartVoiceToneAnalysisTaskRequest$LanguageCode": null + "StartVoiceToneAnalysisTaskRequest$LanguageCode": "

The language code.

" } }, "ListAvailableVoiceConnectorRegionsResponse": { @@ -1000,188 +1000,188 @@ } }, "LoggingConfiguration": { - "base": null, + "base": "

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

", "refs": { - "GetVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration": null, - "PutVoiceConnectorLoggingConfigurationRequest$LoggingConfiguration": null, - "PutVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration": null + "GetVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration": "

The logging configuration details .

", + "PutVoiceConnectorLoggingConfigurationRequest$LoggingConfiguration": "

The logging configuration being updated.

", + "PutVoiceConnectorLoggingConfigurationResponse$LoggingConfiguration": "

The updated logging configuration.

" } }, "MediaInsightsConfiguration": { - "base": null, + "base": "

The configuration for a call analytics task.

", "refs": { - "StreamingConfiguration$MediaInsightsConfiguration": null + "StreamingConfiguration$MediaInsightsConfiguration": "

The call analytics configuration.

" } }, "NextTokenString": { "base": null, "refs": { - "ListProxySessionsRequest$NextToken": null, - "ListProxySessionsResponse$NextToken": null, - "ListSipMediaApplicationsRequest$NextToken": null, - "ListSipMediaApplicationsResponse$NextToken": null, - "ListSipRulesRequest$NextToken": null, - "ListSipRulesResponse$NextToken": null + "ListProxySessionsRequest$NextToken": "

The token used to retrieve the next page of results.

", + "ListProxySessionsResponse$NextToken": "

The token used to retrieve the next page of results.

", + "ListSipMediaApplicationsRequest$NextToken": "

The token used to return the next page of results.

", + "ListSipMediaApplicationsResponse$NextToken": "

The token used to return the next page of results.

", + "ListSipRulesRequest$NextToken": "

The token used to return the next page of results.

", + "ListSipRulesResponse$NextToken": "

The token used to return the next page of results.

" } }, "NonEmptyString": { "base": null, "refs": { - "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$VoiceConnectorGroupId": null, - "AssociatePhoneNumbersWithVoiceConnectorRequest$VoiceConnectorId": null, - "CreateSipMediaApplicationCallRequest$SipMediaApplicationId": null, - "CreateSipRuleRequest$TriggerValue": null, - "DeleteSipMediaApplicationRequest$SipMediaApplicationId": null, - "DeleteSipRuleRequest$SipRuleId": null, - "DeleteVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": null, - "DeleteVoiceConnectorGroupRequest$VoiceConnectorGroupId": null, - "DeleteVoiceConnectorOriginationRequest$VoiceConnectorId": null, - "DeleteVoiceConnectorRequest$VoiceConnectorId": null, - "DeleteVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": null, - "DeleteVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": null, - "DeleteVoiceConnectorTerminationRequest$VoiceConnectorId": null, - "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$VoiceConnectorGroupId": null, - "DisassociatePhoneNumbersFromVoiceConnectorRequest$VoiceConnectorId": null, - "GetSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId": null, - "GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": null, - "GetSipMediaApplicationRequest$SipMediaApplicationId": null, - "GetSipRuleRequest$SipRuleId": null, - "GetVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": null, - "GetVoiceConnectorGroupRequest$VoiceConnectorGroupId": null, - "GetVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId": null, - "GetVoiceConnectorOriginationRequest$VoiceConnectorId": null, - "GetVoiceConnectorRequest$VoiceConnectorId": null, - "GetVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": null, - "GetVoiceConnectorTerminationHealthRequest$VoiceConnectorId": null, - "GetVoiceConnectorTerminationRequest$VoiceConnectorId": null, - "ListSipRulesRequest$SipMediaApplicationId": null, - "ListVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": null, - "PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId": null, - "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": null, - "PutVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": null, - "PutVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId": null, - "PutVoiceConnectorOriginationRequest$VoiceConnectorId": null, - "PutVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": null, - "PutVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": null, - "PutVoiceConnectorTerminationRequest$VoiceConnectorId": null, - "SipMediaApplication$SipMediaApplicationId": null, - "SipRule$SipRuleId": null, - "SipRule$TriggerValue": null, - "SipRuleTargetApplication$SipMediaApplicationId": null, - "SpeakerSearchTask$SpeakerSearchTaskStatus": null, - "UpdateSipMediaApplicationCallRequest$SipMediaApplicationId": null, - "UpdateSipMediaApplicationCallRequest$TransactionId": null, - "UpdateSipMediaApplicationRequest$SipMediaApplicationId": null, - "UpdateSipRuleRequest$SipRuleId": null, - "UpdateVoiceConnectorGroupRequest$VoiceConnectorGroupId": null, - "UpdateVoiceConnectorRequest$VoiceConnectorId": null, - "ValidateE911AddressRequest$AwsAccountId": null, - "VoiceConnector$VoiceConnectorId": null, - "VoiceConnector$VoiceConnectorArn": null, - "VoiceConnectorGroup$VoiceConnectorGroupId": null, - "VoiceConnectorGroup$VoiceConnectorGroupArn": null, - "VoiceConnectorItem$VoiceConnectorId": null, - "VoiceToneAnalysisTask$VoiceToneAnalysisTaskStatus": null + "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$VoiceConnectorGroupId": "

The Amazon Chime SDK Voice Connector group ID.

", + "AssociatePhoneNumbersWithVoiceConnectorRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "CreateSipMediaApplicationCallRequest$SipMediaApplicationId": "

The ID of the SIP media application.

", + "CreateSipRuleRequest$TriggerValue": "

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

", + "DeleteSipMediaApplicationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "DeleteSipRuleRequest$SipRuleId": "

The SIP rule ID.

", + "DeleteVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteVoiceConnectorGroupRequest$VoiceConnectorGroupId": "

The Voice Connector Group ID.

", + "DeleteVoiceConnectorOriginationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteVoiceConnectorRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteVoiceConnectorTerminationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest$VoiceConnectorGroupId": "

The Voice Connector group ID.

", + "DisassociatePhoneNumbersFromVoiceConnectorRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "GetSipMediaApplicationRequest$SipMediaApplicationId": "

The SIP media application ID .

", + "GetSipRuleRequest$SipRuleId": "

The SIP rule ID.

", + "GetVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorGroupRequest$VoiceConnectorGroupId": "

The Voice Connector group ID.

", + "GetVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorOriginationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorTerminationHealthRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorTerminationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "ListSipRulesRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "ListVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "PutVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutVoiceConnectorOriginationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutVoiceConnectorStreamingConfigurationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutVoiceConnectorTerminationCredentialsRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "PutVoiceConnectorTerminationRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "SipMediaApplication$SipMediaApplicationId": "

A SIP media application's ID.

", + "SipRule$SipRuleId": "

A SIP rule's ID.

", + "SipRule$TriggerValue": "

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

", + "SipRuleTargetApplication$SipMediaApplicationId": "

The ID of a rule's target SIP media application.

", + "SpeakerSearchTask$SpeakerSearchTaskStatus": "

The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

", + "UpdateSipMediaApplicationCallRequest$SipMediaApplicationId": "

The ID of the SIP media application handling the call.

", + "UpdateSipMediaApplicationCallRequest$TransactionId": "

The ID of the call transaction.

", + "UpdateSipMediaApplicationRequest$SipMediaApplicationId": "

The SIP media application ID.

", + "UpdateSipRuleRequest$SipRuleId": "

The SIP rule ID.

", + "UpdateVoiceConnectorGroupRequest$VoiceConnectorGroupId": "

The Voice Connector ID.

", + "UpdateVoiceConnectorRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "ValidateE911AddressRequest$AwsAccountId": "

The AWS account ID.

", + "VoiceConnector$VoiceConnectorId": "

The Voice Connector's ID.

", + "VoiceConnector$VoiceConnectorArn": "

The ARN of the Voice Connector.

", + "VoiceConnectorGroup$VoiceConnectorGroupId": "

The ID of a Voice Connector group.

", + "VoiceConnectorGroup$VoiceConnectorGroupArn": "

The ARN of the Voice Connector group.

", + "VoiceConnectorItem$VoiceConnectorId": "

The Voice Connector ID.

", + "VoiceToneAnalysisTask$VoiceToneAnalysisTaskStatus": "

The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

" } }, "NonEmptyString128": { "base": null, "refs": { - "CallDetails$VoiceConnectorId": null, - "CreateProxySessionRequest$VoiceConnectorId": null, - "DeleteProxySessionRequest$VoiceConnectorId": null, - "DeleteProxySessionRequest$ProxySessionId": null, - "DeleteVoiceConnectorProxyRequest$VoiceConnectorId": null, - "GetProxySessionRequest$VoiceConnectorId": null, - "GetProxySessionRequest$ProxySessionId": null, - "GetSpeakerSearchTaskRequest$VoiceConnectorId": null, - "GetVoiceConnectorProxyRequest$VoiceConnectorId": null, - "GetVoiceToneAnalysisTaskRequest$VoiceConnectorId": null, - "ListProxySessionsRequest$VoiceConnectorId": null, - "ProxySession$VoiceConnectorId": null, - "ProxySession$ProxySessionId": null, - "PutVoiceConnectorProxyRequest$VoiceConnectorId": null, - "StartSpeakerSearchTaskRequest$VoiceConnectorId": null, - "StartVoiceToneAnalysisTaskRequest$VoiceConnectorId": null, - "StopSpeakerSearchTaskRequest$VoiceConnectorId": null, - "StopVoiceToneAnalysisTaskRequest$VoiceConnectorId": null, - "UpdateProxySessionRequest$VoiceConnectorId": null, - "UpdateProxySessionRequest$ProxySessionId": null + "CallDetails$VoiceConnectorId": "

The Voice Connector ID.

", + "CreateProxySessionRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteProxySessionRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "DeleteProxySessionRequest$ProxySessionId": "

The proxy session ID.

", + "DeleteVoiceConnectorProxyRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetProxySessionRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetProxySessionRequest$ProxySessionId": "

The proxy session ID.

", + "GetSpeakerSearchTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceConnectorProxyRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "GetVoiceToneAnalysisTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "ListProxySessionsRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "ProxySession$VoiceConnectorId": "

The Voice Connector ID.

", + "ProxySession$ProxySessionId": "

The proxy session ID.

", + "PutVoiceConnectorProxyRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "StartSpeakerSearchTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "StartVoiceToneAnalysisTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "StopSpeakerSearchTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "StopVoiceToneAnalysisTaskRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "UpdateProxySessionRequest$VoiceConnectorId": "

The Voice Connector ID.

", + "UpdateProxySessionRequest$ProxySessionId": "

The proxy session ID.

" } }, "NonEmptyString256": { "base": null, "refs": { - "CallDetails$TransactionId": null, - "CreateVoiceProfileRequest$SpeakerSearchTaskId": null, - "DeleteVoiceProfileDomainRequest$VoiceProfileDomainId": null, - "DeleteVoiceProfileRequest$VoiceProfileId": null, - "GetSpeakerSearchTaskRequest$SpeakerSearchTaskId": null, - "GetVoiceProfileDomainRequest$VoiceProfileDomainId": null, - "GetVoiceProfileRequest$VoiceProfileId": null, - "GetVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId": null, - "ListVoiceProfilesRequest$VoiceProfileDomainId": null, - "SpeakerSearchDetails$VoiceprintGenerationStatus": null, - "SpeakerSearchResult$VoiceProfileId": null, - "SpeakerSearchTask$SpeakerSearchTaskId": null, - "StartSpeakerSearchTaskRequest$TransactionId": null, - "StartSpeakerSearchTaskRequest$VoiceProfileDomainId": null, - "StartVoiceToneAnalysisTaskRequest$TransactionId": null, - "StopSpeakerSearchTaskRequest$SpeakerSearchTaskId": null, - "StopVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId": null, - "UpdateVoiceProfileDomainRequest$VoiceProfileDomainId": null, - "UpdateVoiceProfileRequest$VoiceProfileId": null, - "UpdateVoiceProfileRequest$SpeakerSearchTaskId": null, - "VoiceProfile$VoiceProfileId": null, - "VoiceProfile$VoiceProfileDomainId": null, - "VoiceProfileDomain$VoiceProfileDomainId": null, - "VoiceProfileDomainSummary$VoiceProfileDomainId": null, - "VoiceProfileSummary$VoiceProfileId": null, - "VoiceProfileSummary$VoiceProfileDomainId": null, - "VoiceToneAnalysisTask$VoiceToneAnalysisTaskId": null + "CallDetails$TransactionId": "

The transaction ID of a Voice Connector call.

", + "CreateVoiceProfileRequest$SpeakerSearchTaskId": "

The ID of the speaker search task.

", + "DeleteVoiceProfileDomainRequest$VoiceProfileDomainId": "

The voice profile domain ID.

", + "DeleteVoiceProfileRequest$VoiceProfileId": "

The voice profile ID.

", + "GetSpeakerSearchTaskRequest$SpeakerSearchTaskId": "

The ID of the speaker search task.

", + "GetVoiceProfileDomainRequest$VoiceProfileDomainId": "

The voice profile domain ID.

", + "GetVoiceProfileRequest$VoiceProfileId": "

The voice profile ID.

", + "GetVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId": "

The ID of the voice tone anlysis task.

", + "ListVoiceProfilesRequest$VoiceProfileDomainId": "

The ID of the voice profile domain.

", + "SpeakerSearchDetails$VoiceprintGenerationStatus": "

The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

", + "SpeakerSearchResult$VoiceProfileId": "

The voice profile ID.

", + "SpeakerSearchTask$SpeakerSearchTaskId": "

The speaker search task ID.

", + "StartSpeakerSearchTaskRequest$TransactionId": "

The transaction ID of the call being analyzed.

", + "StartSpeakerSearchTaskRequest$VoiceProfileDomainId": "

The ID of the voice profile domain that will store the voice profile.

", + "StartVoiceToneAnalysisTaskRequest$TransactionId": "

The transaction ID.

", + "StopSpeakerSearchTaskRequest$SpeakerSearchTaskId": "

The speaker search task ID.

", + "StopVoiceToneAnalysisTaskRequest$VoiceToneAnalysisTaskId": "

The ID of the voice tone analysis task.

", + "UpdateVoiceProfileDomainRequest$VoiceProfileDomainId": "

The domain ID.

", + "UpdateVoiceProfileRequest$VoiceProfileId": "

The profile ID.

", + "UpdateVoiceProfileRequest$SpeakerSearchTaskId": "

The ID of the speaker search task.

", + "VoiceProfile$VoiceProfileId": "

The ID of the voice profile.

", + "VoiceProfile$VoiceProfileDomainId": "

The ID of the domain that contains the voice profile.

", + "VoiceProfileDomain$VoiceProfileDomainId": "

The ID of the voice profile domain.

", + "VoiceProfileDomainSummary$VoiceProfileDomainId": "

The ID of the voice profile domain summary.

", + "VoiceProfileSummary$VoiceProfileId": "

The ID of the voice profile in a voice profile summary.

", + "VoiceProfileSummary$VoiceProfileDomainId": "

The ID of the voice profile domain in a voice profile summary.

", + "VoiceToneAnalysisTask$VoiceToneAnalysisTaskId": "

The ID of the voice tone analysis task.

" } }, "NonEmptyStringList": { "base": null, "refs": { - "BatchDeletePhoneNumberRequest$PhoneNumberIds": null + "BatchDeletePhoneNumberRequest$PhoneNumberIds": "

List of phone number IDs.

" } }, "NotFoundException": { - "base": null, + "base": "

The requested resource couldn't be found.

", "refs": { } }, "NotificationTarget": { "base": null, "refs": { - "StreamingNotificationTarget$NotificationTarget": null + "StreamingNotificationTarget$NotificationTarget": "

The streaming notification target.

" } }, "NullableBoolean": { "base": null, "refs": { - "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$ForceAssociate": null, - "AssociatePhoneNumbersWithVoiceConnectorRequest$ForceAssociate": null, - "CreateSipRuleRequest$Disabled": null, - "PhoneNumberCapabilities$InboundCall": null, - "PhoneNumberCapabilities$OutboundCall": null, - "PhoneNumberCapabilities$InboundSMS": null, - "PhoneNumberCapabilities$OutboundSMS": null, - "PhoneNumberCapabilities$InboundMMS": null, - "PhoneNumberCapabilities$OutboundMMS": null, - "UpdateSipRuleRequest$Disabled": null + "AssociatePhoneNumbersWithVoiceConnectorGroupRequest$ForceAssociate": "

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

", + "AssociatePhoneNumbersWithVoiceConnectorRequest$ForceAssociate": "

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

", + "CreateSipRuleRequest$Disabled": "

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

", + "PhoneNumberCapabilities$InboundCall": "

Allows or denies inbound calling for the specified phone number.

", + "PhoneNumberCapabilities$OutboundCall": "

Allows or denies outbound calling for the specified phone number.

", + "PhoneNumberCapabilities$InboundSMS": "

Allows or denies inbound SMS messaging for the specified phone number.

", + "PhoneNumberCapabilities$OutboundSMS": "

Allows or denies outbound SMS messaging for the specified phone number.

", + "PhoneNumberCapabilities$InboundMMS": "

Allows or denies inbound MMS messaging for the specified phone number.

", + "PhoneNumberCapabilities$OutboundMMS": "

Allows or denies inbound MMS messaging for the specified phone number.

", + "UpdateSipRuleRequest$Disabled": "

The new value that indicates whether the rule is disabled.

" } }, "NumberSelectionBehavior": { "base": null, "refs": { - "CreateProxySessionRequest$NumberSelectionBehavior": null, - "ProxySession$NumberSelectionBehavior": null + "CreateProxySessionRequest$NumberSelectionBehavior": "

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

", + "ProxySession$NumberSelectionBehavior": "

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

" } }, "OrderedPhoneNumber": { - "base": null, + "base": "

A phone number for which an order has been placed.

", "refs": { "OrderedPhoneNumberList$member": null } @@ -1189,25 +1189,25 @@ "OrderedPhoneNumberList": { "base": null, "refs": { - "PhoneNumberOrder$OrderedPhoneNumbers": null + "PhoneNumberOrder$OrderedPhoneNumbers": "

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

" } }, "OrderedPhoneNumberStatus": { "base": null, "refs": { - "OrderedPhoneNumber$Status": null + "OrderedPhoneNumber$Status": "

The phone number status.

" } }, "Origination": { - "base": null, + "base": "

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.

The parameters listed below are not required, but you must use at least one.

", "refs": { - "GetVoiceConnectorOriginationResponse$Origination": null, - "PutVoiceConnectorOriginationRequest$Origination": null, - "PutVoiceConnectorOriginationResponse$Origination": null + "GetVoiceConnectorOriginationResponse$Origination": "

The origination setting details.

", + "PutVoiceConnectorOriginationRequest$Origination": "

The origination settings being updated.

", + "PutVoiceConnectorOriginationResponse$Origination": "

The updated origination settings.

" } }, "OriginationRoute": { - "base": null, + "base": "

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

The parameters listed below are not required, but you must use at least one.

", "refs": { "OriginationRouteList$member": null } @@ -1215,29 +1215,29 @@ "OriginationRouteList": { "base": null, "refs": { - "Origination$Routes": null + "Origination$Routes": "

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

" } }, "OriginationRoutePriority": { "base": null, "refs": { - "OriginationRoute$Priority": null + "OriginationRoute$Priority": "

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

" } }, "OriginationRouteProtocol": { "base": null, "refs": { - "OriginationRoute$Protocol": null + "OriginationRoute$Protocol": "

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

" } }, "OriginationRouteWeight": { "base": null, "refs": { - "OriginationRoute$Weight": null + "OriginationRoute$Weight": "

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

" } }, "Participant": { - "base": null, + "base": "

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

", "refs": { "Participants$member": null } @@ -1245,26 +1245,26 @@ "ParticipantPhoneNumberList": { "base": null, "refs": { - "CreateProxySessionRequest$ParticipantPhoneNumbers": null + "CreateProxySessionRequest$ParticipantPhoneNumbers": "

The participant phone numbers.

" } }, "Participants": { "base": null, "refs": { - "ProxySession$Participants": null + "ProxySession$Participants": "

The proxy session participants.

" } }, "PhoneNumber": { - "base": null, + "base": "

A phone number used to call an Amazon Chime SDK Voice Connector.

", "refs": { - "GetPhoneNumberResponse$PhoneNumber": null, + "GetPhoneNumberResponse$PhoneNumber": "

The phone number details.

", "PhoneNumberList$member": null, - "RestorePhoneNumberResponse$PhoneNumber": null, - "UpdatePhoneNumberResponse$PhoneNumber": null + "RestorePhoneNumberResponse$PhoneNumber": "

The restored phone number.

", + "UpdatePhoneNumberResponse$PhoneNumber": "

The updated phone number details.

" } }, "PhoneNumberAssociation": { - "base": null, + "base": "

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

", "refs": { "PhoneNumberAssociationList$member": null } @@ -1272,36 +1272,36 @@ "PhoneNumberAssociationList": { "base": null, "refs": { - "PhoneNumber$Associations": null + "PhoneNumber$Associations": "

The phone number's associations.

" } }, "PhoneNumberAssociationName": { "base": null, "refs": { - "ListPhoneNumbersRequest$FilterName": null, - "PhoneNumberAssociation$Name": null + "ListPhoneNumbersRequest$FilterName": "

The filter to limit the number of results.

", + "PhoneNumberAssociation$Name": "

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

" } }, "PhoneNumberCapabilities": { - "base": null, + "base": "

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.

", "refs": { - "PhoneNumber$Capabilities": null + "PhoneNumber$Capabilities": "

The phone number's capabilities.

" } }, "PhoneNumberCountriesList": { "base": null, "refs": { - "ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries": null + "ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries": "

The supported phone number countries.

" } }, "PhoneNumberCountry": { - "base": null, + "base": "

The phone number's country.

", "refs": { "PhoneNumberCountriesList$member": null } }, "PhoneNumberError": { - "base": null, + "base": "

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

", "refs": { "PhoneNumberErrorList$member": null } @@ -1309,131 +1309,131 @@ "PhoneNumberErrorList": { "base": null, "refs": { - "AssociatePhoneNumbersWithVoiceConnectorGroupResponse$PhoneNumberErrors": null, - "AssociatePhoneNumbersWithVoiceConnectorResponse$PhoneNumberErrors": null, - "BatchDeletePhoneNumberResponse$PhoneNumberErrors": null, - "BatchUpdatePhoneNumberResponse$PhoneNumberErrors": null, - "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse$PhoneNumberErrors": null, - "DisassociatePhoneNumbersFromVoiceConnectorResponse$PhoneNumberErrors": null + "AssociatePhoneNumbersWithVoiceConnectorGroupResponse$PhoneNumberErrors": "

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

", + "AssociatePhoneNumbersWithVoiceConnectorResponse$PhoneNumberErrors": "

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

", + "BatchDeletePhoneNumberResponse$PhoneNumberErrors": "

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

", + "BatchUpdatePhoneNumberResponse$PhoneNumberErrors": "

A list of failed phone numbers and their error messages.

", + "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse$PhoneNumberErrors": "

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

", + "DisassociatePhoneNumbersFromVoiceConnectorResponse$PhoneNumberErrors": "

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" } }, "PhoneNumberList": { "base": null, "refs": { - "ListPhoneNumbersResponse$PhoneNumbers": null + "ListPhoneNumbersResponse$PhoneNumbers": "

The phone number details.

" } }, "PhoneNumberMaxResults": { "base": null, "refs": { - "SearchAvailablePhoneNumbersRequest$MaxResults": null + "SearchAvailablePhoneNumbersRequest$MaxResults": "

The maximum number of results to return.

" } }, "PhoneNumberOrder": { - "base": null, + "base": "

The details of an Amazon Chime SDK phone number order.

", "refs": { - "CreatePhoneNumberOrderResponse$PhoneNumberOrder": null, - "GetPhoneNumberOrderResponse$PhoneNumberOrder": null, + "CreatePhoneNumberOrderResponse$PhoneNumberOrder": "

The phone number order details.

", + "GetPhoneNumberOrderResponse$PhoneNumberOrder": "

The phone number order details.

", "PhoneNumberOrderList$member": null } }, "PhoneNumberOrderList": { "base": null, "refs": { - "ListPhoneNumberOrdersResponse$PhoneNumberOrders": null + "ListPhoneNumberOrdersResponse$PhoneNumberOrders": "

The phone number order details.

" } }, "PhoneNumberOrderStatus": { "base": null, "refs": { - "PhoneNumberOrder$Status": null + "PhoneNumberOrder$Status": "

The status of the phone number order.

" } }, "PhoneNumberOrderType": { "base": null, "refs": { - "PhoneNumberOrder$OrderType": null + "PhoneNumberOrder$OrderType": "

The type of phone number being ordered, local or toll-free.

" } }, "PhoneNumberProductType": { "base": null, "refs": { - "CreatePhoneNumberOrderRequest$ProductType": null, - "ListPhoneNumbersRequest$ProductType": null, - "ListSupportedPhoneNumberCountriesRequest$ProductType": null, - "PhoneNumber$ProductType": null, - "PhoneNumberOrder$ProductType": null, - "UpdatePhoneNumberRequest$ProductType": null, - "UpdatePhoneNumberRequestItem$ProductType": null + "CreatePhoneNumberOrderRequest$ProductType": "

The phone number product type.

", + "ListPhoneNumbersRequest$ProductType": "

The phone number product types.

", + "ListSupportedPhoneNumberCountriesRequest$ProductType": "

The phone number product type.

", + "PhoneNumber$ProductType": "

The phone number's product type.

", + "PhoneNumberOrder$ProductType": "

The phone number order product type.

", + "UpdatePhoneNumberRequest$ProductType": "

The product type.

", + "UpdatePhoneNumberRequestItem$ProductType": "

The product type to update.

" } }, "PhoneNumberStatus": { "base": null, "refs": { - "PhoneNumber$Status": null + "PhoneNumber$Status": "

The phone number's status.

" } }, "PhoneNumberType": { "base": null, "refs": { - "PhoneNumber$Type": null, + "PhoneNumber$Type": "

The phone number's type.

", "PhoneNumberTypeList$member": null, - "SearchAvailablePhoneNumbersRequest$PhoneNumberType": null + "SearchAvailablePhoneNumbersRequest$PhoneNumberType": "

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

" } }, "PhoneNumberTypeList": { "base": null, "refs": { - "PhoneNumberCountry$SupportedPhoneNumberTypes": null + "PhoneNumberCountry$SupportedPhoneNumberTypes": "

The supported phone number types.

" } }, "Port": { "base": null, "refs": { - "OriginationRoute$Port": null + "OriginationRoute$Port": "

The designated origination route port. Defaults to 5060.

" } }, "PositiveInteger": { "base": null, "refs": { - "CreateProxySessionRequest$ExpiryMinutes": null, - "ProxySession$ExpiryMinutes": null, - "UpdateProxySessionRequest$ExpiryMinutes": null + "CreateProxySessionRequest$ExpiryMinutes": "

The number of minutes allowed for the proxy session.

", + "ProxySession$ExpiryMinutes": "

The number of minutes allowed for the proxy session.

", + "UpdateProxySessionRequest$ExpiryMinutes": "

The number of minutes allowed for the proxy session.

" } }, "Proxy": { - "base": null, + "base": "

The proxy configuration for an Amazon Chime SDK Voice Connector.

", "refs": { - "GetVoiceConnectorProxyResponse$Proxy": null, - "PutVoiceConnectorProxyResponse$Proxy": null + "GetVoiceConnectorProxyResponse$Proxy": "

The proxy configuration details.

", + "PutVoiceConnectorProxyResponse$Proxy": "

The proxy configuration details.

" } }, "ProxySession": { - "base": null, + "base": "

The proxy session for an Amazon Chime SDK Voice Connector.

", "refs": { - "CreateProxySessionResponse$ProxySession": null, - "GetProxySessionResponse$ProxySession": null, + "CreateProxySessionResponse$ProxySession": "

The proxy session details.

", + "GetProxySessionResponse$ProxySession": "

The proxy session details.

", "ProxySessions$member": null, - "UpdateProxySessionResponse$ProxySession": null + "UpdateProxySessionResponse$ProxySession": "

The updated proxy session details.

" } }, "ProxySessionNameString": { "base": null, "refs": { - "CreateProxySessionRequest$Name": null + "CreateProxySessionRequest$Name": "

The name of the proxy session.

" } }, "ProxySessionStatus": { "base": null, "refs": { - "ListProxySessionsRequest$Status": null, - "ProxySession$Status": null + "ListProxySessionsRequest$Status": "

The proxy session status.

", + "ProxySession$Status": "

The proxy session status.

" } }, "ProxySessions": { "base": null, "refs": { - "ListProxySessionsResponse$ProxySessions": null + "ListProxySessionsResponse$ProxySessions": "

The proxy sessions' details.

" } }, "PutSipMediaApplicationAlexaSkillConfigurationRequest": { @@ -1522,7 +1522,7 @@ } }, "ResourceLimitExceededException": { - "base": null, + "base": "

The request exceeds the resource limit.

", "refs": { } }, @@ -1539,27 +1539,27 @@ "ResultMax": { "base": null, "refs": { - "ListPhoneNumberOrdersRequest$MaxResults": null, - "ListPhoneNumbersRequest$MaxResults": null, - "ListProxySessionsRequest$MaxResults": null, - "ListSipMediaApplicationsRequest$MaxResults": null, - "ListSipRulesRequest$MaxResults": null, - "ListVoiceConnectorGroupsRequest$MaxResults": null, - "ListVoiceConnectorsRequest$MaxResults": null, - "ListVoiceProfileDomainsRequest$MaxResults": null, - "ListVoiceProfilesRequest$MaxResults": null + "ListPhoneNumberOrdersRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListPhoneNumbersRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListProxySessionsRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListSipMediaApplicationsRequest$MaxResults": "

The maximum number of results to return in a single call. Defaults to 100.

", + "ListSipRulesRequest$MaxResults": "

The maximum number of results to return in a single call. Defaults to 100.

", + "ListVoiceConnectorGroupsRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListVoiceConnectorsRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListVoiceProfileDomainsRequest$MaxResults": "

The maximum number of results to return in a single call.

", + "ListVoiceProfilesRequest$MaxResults": "

The maximum number of results in the request.

" } }, "SMACreateCallArgumentsMap": { "base": null, "refs": { - "CreateSipMediaApplicationCallRequest$ArgumentsMap": null + "CreateSipMediaApplicationCallRequest$ArgumentsMap": "

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: \"FirstName\": \"John\", \"LastName\": \"Doe\"

" } }, "SMAUpdateCallArgumentsMap": { "base": null, "refs": { - "UpdateSipMediaApplicationCallRequest$Arguments": null + "UpdateSipMediaApplicationCallRequest$Arguments": "

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

" } }, "SearchAvailablePhoneNumbersRequest": { @@ -1575,43 +1575,43 @@ "SensitiveNonEmptyString": { "base": null, "refs": { - "Address$streetName": null, - "Address$streetSuffix": null, - "Address$postDirectional": null, - "Address$preDirectional": null, - "Address$streetNumber": null, - "Address$city": null, - "Address$state": null, - "Address$postalCode": null, - "Address$postalCodePlus4": null, - "Address$country": null, - "CandidateAddress$streetInfo": null, - "CandidateAddress$streetNumber": null, - "CandidateAddress$city": null, - "CandidateAddress$state": null, - "CandidateAddress$postalCode": null, - "CandidateAddress$postalCodePlus4": null, - "CandidateAddress$country": null, - "DeletePhoneNumberRequest$PhoneNumberId": null, - "GetPhoneNumberRequest$PhoneNumberId": null, - "PhoneNumber$PhoneNumberId": null, - "PhoneNumberError$PhoneNumberId": null, - "RestorePhoneNumberRequest$PhoneNumberId": null, - "UpdatePhoneNumberRequest$PhoneNumberId": null, - "UpdatePhoneNumberRequestItem$PhoneNumberId": null, - "ValidateE911AddressRequest$StreetNumber": null, - "ValidateE911AddressRequest$StreetInfo": null, - "ValidateE911AddressRequest$City": null, - "ValidateE911AddressRequest$State": null, - "ValidateE911AddressRequest$Country": null, - "ValidateE911AddressRequest$PostalCode": null + "Address$streetName": "

The address street, such as 8th Avenue.

", + "Address$streetSuffix": "

The address suffix, such as the N in 8th Avenue N.

", + "Address$postDirectional": "

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

", + "Address$preDirectional": "

An address prefix location, such as the N in N. Third St.

", + "Address$streetNumber": "

The numeric portion of an address.

", + "Address$city": "

The city of an address.

", + "Address$state": "

The state of an address.

", + "Address$postalCode": "

The postal code of an address.

", + "Address$postalCodePlus4": "

The zip + 4 or postal code + 4 of an address.

", + "Address$country": "

The country of an address.

", + "CandidateAddress$streetInfo": "

The street information of the candidate address.

", + "CandidateAddress$streetNumber": "

The numeric portion of the candidate address.

", + "CandidateAddress$city": "

The city of the candidate address.

", + "CandidateAddress$state": "

The state of the candidate address.

", + "CandidateAddress$postalCode": "

The postal code of the candidate address.

", + "CandidateAddress$postalCodePlus4": "

The zip + 4 or postal code +4 of the candidate address.

", + "CandidateAddress$country": "

The country of the candidate address.

", + "DeletePhoneNumberRequest$PhoneNumberId": "

The phone number ID.

", + "GetPhoneNumberRequest$PhoneNumberId": "

The phone number ID.

", + "PhoneNumber$PhoneNumberId": "

The phone number's ID.

", + "PhoneNumberError$PhoneNumberId": "

The phone number ID for which the action failed.

", + "RestorePhoneNumberRequest$PhoneNumberId": "

The ID of the phone number being restored.

", + "UpdatePhoneNumberRequest$PhoneNumberId": "

The phone number ID.

", + "UpdatePhoneNumberRequestItem$PhoneNumberId": "

The phone number ID to update.

", + "ValidateE911AddressRequest$StreetNumber": "

The address street number, such as 200 or 2121.

", + "ValidateE911AddressRequest$StreetInfo": "

The address street information, such as 8th Avenue.

", + "ValidateE911AddressRequest$City": "

The address city, such as Portland.

", + "ValidateE911AddressRequest$State": "

The address state, such as ME.

", + "ValidateE911AddressRequest$Country": "

The country in the address being validated.

", + "ValidateE911AddressRequest$PostalCode": "

The dress postal code, such 04352.

" } }, "SensitiveString": { "base": null, "refs": { - "Credential$Username": null, - "Credential$Password": null, + "Credential$Username": "

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

", + "Credential$Password": "

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

", "SMACreateCallArgumentsMap$key": null, "SMACreateCallArgumentsMap$value": null, "SMAUpdateCallArgumentsMap$key": null, @@ -1624,65 +1624,65 @@ "SensitiveStringList": { "base": null, "refs": { - "DeleteVoiceConnectorTerminationCredentialsRequest$Usernames": null, - "ListVoiceConnectorTerminationCredentialsResponse$Usernames": null + "DeleteVoiceConnectorTerminationCredentialsRequest$Usernames": "

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

", + "ListVoiceConnectorTerminationCredentialsResponse$Usernames": "

A list of user names.

" } }, "ServerSideEncryptionConfiguration": { - "base": null, + "base": "

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

", "refs": { - "CreateVoiceProfileDomainRequest$ServerSideEncryptionConfiguration": null, - "VoiceProfileDomain$ServerSideEncryptionConfiguration": null + "CreateVoiceProfileDomainRequest$ServerSideEncryptionConfiguration": "

The server-side encryption configuration for the request.

", + "VoiceProfileDomain$ServerSideEncryptionConfiguration": "

A structure that contains the configuration settings for server-side encryption.

" } }, "ServiceFailureException": { - "base": null, + "base": "

The service encountered an unexpected error.

", "refs": { } }, "ServiceUnavailableException": { - "base": null, + "base": "

The service is currently unavailable.

", "refs": { } }, "SipApplicationPriority": { "base": null, "refs": { - "SipRuleTargetApplication$Priority": null + "SipRuleTargetApplication$Priority": "

The priority setting of a rule's target SIP media application.

" } }, "SipHeadersMap": { "base": null, "refs": { - "CreateSipMediaApplicationCallRequest$SipHeaders": null + "CreateSipMediaApplicationCallRequest$SipHeaders": "

The SIP headers added to an outbound call leg.

" } }, "SipMediaApplication": { - "base": null, + "base": "

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

", "refs": { - "CreateSipMediaApplicationResponse$SipMediaApplication": null, - "GetSipMediaApplicationResponse$SipMediaApplication": null, + "CreateSipMediaApplicationResponse$SipMediaApplication": "

The SIP media application details.

", + "GetSipMediaApplicationResponse$SipMediaApplication": "

The details of the SIP media application.

", "SipMediaApplicationList$member": null, - "UpdateSipMediaApplicationResponse$SipMediaApplication": null + "UpdateSipMediaApplicationResponse$SipMediaApplication": "

The updated SIP media application’s details.

" } }, "SipMediaApplicationAlexaSkillConfiguration": { - "base": null, + "base": "

The Alexa Skill configuration of a SIP media application.

", "refs": { - "GetSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration": null, - "PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationAlexaSkillConfiguration": null, - "PutSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration": null + "GetSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration": "

Returns the Alexa Skill configuration.

", + "PutSipMediaApplicationAlexaSkillConfigurationRequest$SipMediaApplicationAlexaSkillConfiguration": "

The Alexa Skill configuration.

", + "PutSipMediaApplicationAlexaSkillConfigurationResponse$SipMediaApplicationAlexaSkillConfiguration": "

Returns the Alexa Skill configuration.

" } }, "SipMediaApplicationCall": { - "base": null, + "base": "

A Call instance for a SIP media application.

", "refs": { - "CreateSipMediaApplicationCallResponse$SipMediaApplicationCall": null, - "UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall": null + "CreateSipMediaApplicationCallResponse$SipMediaApplicationCall": "

The actual call.

", + "UpdateSipMediaApplicationCallResponse$SipMediaApplicationCall": "

A Call instance for a SIP media application.

" } }, "SipMediaApplicationEndpoint": { - "base": null, + "base": "

The endpoint assigned to a SIP media application.

", "refs": { "SipMediaApplicationEndpointList$member": null } @@ -1690,58 +1690,58 @@ "SipMediaApplicationEndpointList": { "base": null, "refs": { - "CreateSipMediaApplicationRequest$Endpoints": null, - "SipMediaApplication$Endpoints": null, - "UpdateSipMediaApplicationRequest$Endpoints": null + "CreateSipMediaApplicationRequest$Endpoints": "

List of endpoints (Lambda ARNs) specified for the SIP media application.

", + "SipMediaApplication$Endpoints": "

List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

", + "UpdateSipMediaApplicationRequest$Endpoints": "

The new set of endpoints for the specified SIP media application.

" } }, "SipMediaApplicationList": { "base": null, "refs": { - "ListSipMediaApplicationsResponse$SipMediaApplications": null + "ListSipMediaApplicationsResponse$SipMediaApplications": "

The list of SIP media applications and application details.

" } }, "SipMediaApplicationLoggingConfiguration": { - "base": null, + "base": "

The logging configuration of a SIP media application.

", "refs": { - "GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": null, - "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration": null, - "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": null + "GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "

The actual logging configuration.

", + "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration": "

The logging configuration for the specified SIP media application.

", + "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "

The updated logging configuration for the specified SIP media application.

" } }, "SipMediaApplicationName": { "base": null, "refs": { - "CreateSipMediaApplicationRequest$Name": null, - "SipMediaApplication$Name": null, - "UpdateSipMediaApplicationRequest$Name": null + "CreateSipMediaApplicationRequest$Name": "

The SIP media application's name.

", + "SipMediaApplication$Name": "

The SIP media application's name.

", + "UpdateSipMediaApplicationRequest$Name": "

The new name for the specified SIP media application.

" } }, "SipRule": { - "base": null, + "base": "

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

", "refs": { - "CreateSipRuleResponse$SipRule": null, - "GetSipRuleResponse$SipRule": null, + "CreateSipRuleResponse$SipRule": "

The SIP rule information, including the rule ID, triggers, and target applications.

", + "GetSipRuleResponse$SipRule": "

The SIP rule details.

", "SipRuleList$member": null, - "UpdateSipRuleResponse$SipRule": null + "UpdateSipRuleResponse$SipRule": "

The updated SIP rule details.

" } }, "SipRuleList": { "base": null, "refs": { - "ListSipRulesResponse$SipRules": null + "ListSipRulesResponse$SipRules": "

The list of SIP rules and details.

" } }, "SipRuleName": { "base": null, "refs": { - "CreateSipRuleRequest$Name": null, - "SipRule$Name": null, - "UpdateSipRuleRequest$Name": null + "CreateSipRuleRequest$Name": "

The name of the SIP rule.

", + "SipRule$Name": "

A SIP rule's name.

", + "UpdateSipRuleRequest$Name": "

The new name for the specified SIP rule.

" } }, "SipRuleTargetApplication": { - "base": null, + "base": "

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

", "refs": { "SipRuleTargetApplicationList$member": null } @@ -1749,26 +1749,26 @@ "SipRuleTargetApplicationList": { "base": null, "refs": { - "CreateSipRuleRequest$TargetApplications": null, - "SipRule$TargetApplications": null, - "UpdateSipRuleRequest$TargetApplications": null + "CreateSipRuleRequest$TargetApplications": "

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

", + "SipRule$TargetApplications": "

The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

", + "UpdateSipRuleRequest$TargetApplications": "

The new list of target applications.

" } }, "SipRuleTriggerType": { "base": null, "refs": { - "CreateSipRuleRequest$TriggerType": null, - "SipRule$TriggerType": null + "CreateSipRuleRequest$TriggerType": "

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

", + "SipRule$TriggerType": "

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

" } }, "SpeakerSearchDetails": { - "base": null, + "base": "

The details of a speaker search task.

", "refs": { - "SpeakerSearchTask$SpeakerSearchDetails": null + "SpeakerSearchTask$SpeakerSearchDetails": "

The details of a speaker search task.

" } }, "SpeakerSearchResult": { - "base": null, + "base": "

The result of a speaker search analysis.

", "refs": { "SpeakerSearchResultList$member": null } @@ -1776,14 +1776,14 @@ "SpeakerSearchResultList": { "base": null, "refs": { - "SpeakerSearchDetails$Results": null + "SpeakerSearchDetails$Results": "

The result value in the speaker search details.

" } }, "SpeakerSearchTask": { - "base": null, + "base": "

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

", "refs": { - "GetSpeakerSearchTaskResponse$SpeakerSearchTask": null, - "StartSpeakerSearchTaskResponse$SpeakerSearchTask": null + "GetSpeakerSearchTaskResponse$SpeakerSearchTask": "

The details of the speaker search task.

", + "StartSpeakerSearchTaskResponse$SpeakerSearchTask": "

The details of the speaker search task.

" } }, "StartSpeakerSearchTaskRequest": { @@ -1817,15 +1817,15 @@ } }, "StreamingConfiguration": { - "base": null, + "base": "

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

", "refs": { - "GetVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration": null, - "PutVoiceConnectorStreamingConfigurationRequest$StreamingConfiguration": null, - "PutVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration": null + "GetVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration": "

The details of the streaming configuration.

", + "PutVoiceConnectorStreamingConfigurationRequest$StreamingConfiguration": "

The streaming settings being updated.

", + "PutVoiceConnectorStreamingConfigurationResponse$StreamingConfiguration": "

The updated streaming settings.

" } }, "StreamingNotificationTarget": { - "base": null, + "base": "

The target recipient for a streaming configuration notification.

", "refs": { "StreamingNotificationTargetList$member": null } @@ -1833,62 +1833,62 @@ "StreamingNotificationTargetList": { "base": null, "refs": { - "StreamingConfiguration$StreamingNotificationTargets": null + "StreamingConfiguration$StreamingNotificationTargets": "

The streaming notification targets.

" } }, "String": { "base": null, "refs": { - "CreateSipMediaApplicationRequest$AwsRegion": null, - "ListPhoneNumberOrdersRequest$NextToken": null, - "ListPhoneNumberOrdersResponse$NextToken": null, - "ListPhoneNumbersRequest$Status": null, - "ListPhoneNumbersRequest$FilterValue": null, - "ListPhoneNumbersRequest$NextToken": null, - "ListPhoneNumbersResponse$NextToken": null, - "ListVoiceConnectorGroupsRequest$NextToken": null, - "ListVoiceConnectorGroupsResponse$NextToken": null, - "ListVoiceConnectorsRequest$NextToken": null, - "ListVoiceConnectorsResponse$NextToken": null, - "ListVoiceProfileDomainsRequest$NextToken": null, - "ListVoiceProfileDomainsResponse$NextToken": null, - "ListVoiceProfilesRequest$NextToken": null, - "ListVoiceProfilesResponse$NextToken": null, + "CreateSipMediaApplicationRequest$AwsRegion": "

The AWS Region assigned to the SIP media application.

", + "ListPhoneNumberOrdersRequest$NextToken": "

The token used to retrieve the next page of results.

", + "ListPhoneNumberOrdersResponse$NextToken": "

The token used to retrieve the next page of results.

", + "ListPhoneNumbersRequest$Status": "

The status of your organization's phone numbers.

", + "ListPhoneNumbersRequest$FilterValue": "

The filter value.

", + "ListPhoneNumbersRequest$NextToken": "

The token used to return the next page of results.

", + "ListPhoneNumbersResponse$NextToken": "

The token used to return the next page of results.

", + "ListVoiceConnectorGroupsRequest$NextToken": "

The token used to return the next page of results.

", + "ListVoiceConnectorGroupsResponse$NextToken": "

The token used to return the next page of results.

", + "ListVoiceConnectorsRequest$NextToken": "

The token used to return the next page of results.

", + "ListVoiceConnectorsResponse$NextToken": "

The token used to return the next page of results.

", + "ListVoiceProfileDomainsRequest$NextToken": "

The token used to return the next page of results.

", + "ListVoiceProfileDomainsResponse$NextToken": "

The token used to return the next page of results.

", + "ListVoiceProfilesRequest$NextToken": "

The token used to retrieve the next page of results.

", + "ListVoiceProfilesResponse$NextToken": "

The token used to retrieve the next page of results.

", "NonEmptyStringList$member": null, - "OriginationRoute$Host": null, - "PhoneNumberAssociation$Value": null, - "PhoneNumberError$ErrorMessage": null, - "SearchAvailablePhoneNumbersRequest$AreaCode": null, - "SearchAvailablePhoneNumbersRequest$City": null, - "SearchAvailablePhoneNumbersRequest$State": null, - "SearchAvailablePhoneNumbersRequest$NextToken": null, - "SearchAvailablePhoneNumbersResponse$NextToken": null, - "SipMediaApplication$AwsRegion": null, - "SipRuleTargetApplication$AwsRegion": null, - "SpeakerSearchTask$StatusMessage": null, + "OriginationRoute$Host": "

The FQDN or IP address to contact for origination traffic.

", + "PhoneNumberAssociation$Value": "

Contains the ID for the entity specified in Name.

", + "PhoneNumberError$ErrorMessage": "

The error message.

", + "SearchAvailablePhoneNumbersRequest$AreaCode": "

Confines a search to just the phone numbers associated with the specified area code.

", + "SearchAvailablePhoneNumbersRequest$City": "

Confines a search to just the phone numbers associated with the specified city.

", + "SearchAvailablePhoneNumbersRequest$State": "

Confines a search to just the phone numbers associated with the specified state.

", + "SearchAvailablePhoneNumbersRequest$NextToken": "

The token used to return the next page of results.

", + "SearchAvailablePhoneNumbersResponse$NextToken": "

The token used to return the next page of results.

", + "SipMediaApplication$AwsRegion": "

The AWS Region in which the SIP media application is created.

", + "SipRuleTargetApplication$AwsRegion": "

The AWS Region of a rule's target SIP media application.

", + "SpeakerSearchTask$StatusMessage": "

A detailed message about the status of a speaker search.

", "StringList$member": null, - "TerminationHealth$Source": null, - "ValidateE911AddressResponse$AddressExternalId": null, - "VoiceConnector$OutboundHostName": null, - "VoiceConnectorSettings$CdrBucket": null, - "VoiceToneAnalysisTask$StatusMessage": null + "TerminationHealth$Source": "

The source IP address.

", + "ValidateE911AddressResponse$AddressExternalId": "

The ID that represents the address.

", + "VoiceConnector$OutboundHostName": "

The outbound host name for the Voice Connector.

", + "VoiceConnectorSettings$CdrBucket": "

The S3 bucket that stores the Voice Connector's call detail records.

", + "VoiceToneAnalysisTask$StatusMessage": "

The status of a voice tone analysis task.

" } }, "String128": { "base": null, "refs": { - "ProxySession$Name": null + "ProxySession$Name": "

The proxy session name.

" } }, "StringList": { "base": null, "refs": { - "Proxy$PhoneNumberCountries": null, - "Termination$CidrAllowedList": null + "Proxy$PhoneNumberCountries": "

The countries for proxy phone numbers to be selected from.

", + "Termination$CidrAllowedList": "

The IP addresses allowed to make calls, in CIDR format.

" } }, "Tag": { - "base": null, + "base": "

Describes a tag applied to a resource.

", "refs": { "TagList$member": null } @@ -1896,22 +1896,22 @@ "TagKey": { "base": null, "refs": { - "Tag$Key": null, + "Tag$Key": "

The tag's key.

", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$TagKeys": null + "UntagResourceRequest$TagKeys": "

The keys of the tags being removed from the resource.

" } }, "TagList": { "base": null, "refs": { - "CreateVoiceProfileDomainRequest$Tags": null, - "ListTagsForResourceResponse$Tags": null, - "TagResourceRequest$Tags": null + "CreateVoiceProfileDomainRequest$Tags": "

The tags assigned to the domain.

", + "ListTagsForResourceResponse$Tags": "

The tags in the list.

", + "TagResourceRequest$Tags": "

A list of the tags being added to the resource.

" } }, "TagResourceRequest": { @@ -1922,41 +1922,41 @@ "TagValue": { "base": null, "refs": { - "Tag$Value": null + "Tag$Value": "

The tag's value.

" } }, "Termination": { - "base": null, + "base": "

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

", "refs": { - "GetVoiceConnectorTerminationResponse$Termination": null, - "PutVoiceConnectorTerminationRequest$Termination": null, - "PutVoiceConnectorTerminationResponse$Termination": null + "GetVoiceConnectorTerminationResponse$Termination": "

The termination setting details.

", + "PutVoiceConnectorTerminationRequest$Termination": "

The termination settings to be updated.

", + "PutVoiceConnectorTerminationResponse$Termination": "

The updated termination settings.

" } }, "TerminationHealth": { - "base": null, + "base": "

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

", "refs": { - "GetVoiceConnectorTerminationHealthResponse$TerminationHealth": null + "GetVoiceConnectorTerminationHealthResponse$TerminationHealth": "

The termination health details.

" } }, "ThrottledClientException": { - "base": null, + "base": "

The number of customer requests exceeds the request rate limit.

", "refs": { } }, "TollFreePrefix": { "base": null, "refs": { - "SearchAvailablePhoneNumbersRequest$TollFreePrefix": null + "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "

Confines a search to just the phone numbers associated with the specified toll-free prefix.

" } }, "UnauthorizedClientException": { - "base": null, + "base": "

The client isn't authorized to request a resource.

", "refs": { } }, "UnprocessableEntityException": { - "base": null, + "base": "

A well-formed request couldn't be followed due to semantic errors.

", "refs": { } }, @@ -1976,7 +1976,7 @@ } }, "UpdatePhoneNumberRequestItem": { - "base": null, + "base": "

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

", "refs": { "UpdatePhoneNumberRequestItemList$member": null } @@ -1984,7 +1984,7 @@ "UpdatePhoneNumberRequestItemList": { "base": null, "refs": { - "BatchUpdatePhoneNumberRequest$UpdatePhoneNumberRequestItems": null + "BatchUpdatePhoneNumberRequest$UpdatePhoneNumberRequestItems": "

Lists the phone numbers in the update request.

" } }, "UpdatePhoneNumberResponse": { @@ -2090,57 +2090,57 @@ "ValidationResult": { "base": null, "refs": { - "ValidateE911AddressResponse$ValidationResult": null + "ValidateE911AddressResponse$ValidationResult": "

Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

" } }, "VoiceConnector": { - "base": null, + "base": "

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.

", "refs": { - "CreateVoiceConnectorResponse$VoiceConnector": null, - "GetVoiceConnectorResponse$VoiceConnector": null, - "UpdateVoiceConnectorResponse$VoiceConnector": null, + "CreateVoiceConnectorResponse$VoiceConnector": "

The details of the Voice Connector.

", + "GetVoiceConnectorResponse$VoiceConnector": "

The Voice Connector details.

", + "UpdateVoiceConnectorResponse$VoiceConnector": "

The updated Voice Connector details.

", "VoiceConnectorList$member": null } }, "VoiceConnectorAwsRegion": { "base": null, "refs": { - "CreateVoiceConnectorRequest$AwsRegion": null, - "VoiceConnector$AwsRegion": null, + "CreateVoiceConnectorRequest$AwsRegion": "

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

", + "VoiceConnector$AwsRegion": "

The AWS Region in which the Voice Connector is created. Default: us-east-1.

", "VoiceConnectorAwsRegionList$member": null } }, "VoiceConnectorAwsRegionList": { "base": null, "refs": { - "ListAvailableVoiceConnectorRegionsResponse$VoiceConnectorRegions": null + "ListAvailableVoiceConnectorRegionsResponse$VoiceConnectorRegions": "

The list of AWS Regions.

" } }, "VoiceConnectorGroup": { - "base": null, + "base": "

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

", "refs": { - "CreateVoiceConnectorGroupResponse$VoiceConnectorGroup": null, - "GetVoiceConnectorGroupResponse$VoiceConnectorGroup": null, - "UpdateVoiceConnectorGroupResponse$VoiceConnectorGroup": null, + "CreateVoiceConnectorGroupResponse$VoiceConnectorGroup": "

The details of the Voice Connector group.

", + "GetVoiceConnectorGroupResponse$VoiceConnectorGroup": "

The details of the Voice Connector group.

", + "UpdateVoiceConnectorGroupResponse$VoiceConnectorGroup": "

The updated Voice Connector group.

", "VoiceConnectorGroupList$member": null } }, "VoiceConnectorGroupList": { "base": null, "refs": { - "ListVoiceConnectorGroupsResponse$VoiceConnectorGroups": null + "ListVoiceConnectorGroupsResponse$VoiceConnectorGroups": "

The details of the Voice Connector groups.

" } }, "VoiceConnectorGroupName": { "base": null, "refs": { - "CreateVoiceConnectorGroupRequest$Name": null, - "UpdateVoiceConnectorGroupRequest$Name": null, - "VoiceConnectorGroup$Name": null + "CreateVoiceConnectorGroupRequest$Name": "

The name of the Voice Connector group.

", + "UpdateVoiceConnectorGroupRequest$Name": "

The name of the Voice Connector group.

", + "VoiceConnectorGroup$Name": "

The name of a Voice Connector group.

" } }, "VoiceConnectorItem": { - "base": null, + "base": "

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

", "refs": { "VoiceConnectorItemList$member": null } @@ -2148,74 +2148,74 @@ "VoiceConnectorItemList": { "base": null, "refs": { - "CreateVoiceConnectorGroupRequest$VoiceConnectorItems": null, - "UpdateVoiceConnectorGroupRequest$VoiceConnectorItems": null, - "VoiceConnectorGroup$VoiceConnectorItems": null + "CreateVoiceConnectorGroupRequest$VoiceConnectorItems": "

Lists the Voice Connectors that inbound calls are routed to.

", + "UpdateVoiceConnectorGroupRequest$VoiceConnectorItems": "

The VoiceConnectorItems to associate with the Voice Connector group.

", + "VoiceConnectorGroup$VoiceConnectorItems": "

The Voice Connectors to which you route inbound calls.

" } }, "VoiceConnectorItemPriority": { "base": null, "refs": { - "VoiceConnectorItem$Priority": null + "VoiceConnectorItem$Priority": "

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

" } }, "VoiceConnectorList": { "base": null, "refs": { - "ListVoiceConnectorsResponse$VoiceConnectors": null + "ListVoiceConnectorsResponse$VoiceConnectors": "

The details of the Voice Connectors.

" } }, "VoiceConnectorName": { "base": null, "refs": { - "CreateVoiceConnectorRequest$Name": null, - "UpdateVoiceConnectorRequest$Name": null, - "VoiceConnector$Name": null + "CreateVoiceConnectorRequest$Name": "

The name of the Voice Connector.

", + "UpdateVoiceConnectorRequest$Name": "

The name of the Voice Connector.

", + "VoiceConnector$Name": "

The Voice Connector's name.

" } }, "VoiceConnectorSettings": { - "base": null, + "base": "

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

", "refs": { - "GetGlobalSettingsResponse$VoiceConnector": null, - "UpdateGlobalSettingsRequest$VoiceConnector": null + "GetGlobalSettingsResponse$VoiceConnector": "

The Voice Connector settings.

", + "UpdateGlobalSettingsRequest$VoiceConnector": "

The Voice Connector settings.

" } }, "VoiceProfile": { - "base": null, + "base": "

The combination of a voice print and caller ID.

", "refs": { - "CreateVoiceProfileResponse$VoiceProfile": null, - "GetVoiceProfileResponse$VoiceProfile": null, - "UpdateVoiceProfileResponse$VoiceProfile": null + "CreateVoiceProfileResponse$VoiceProfile": "

The requested voice profile.

", + "GetVoiceProfileResponse$VoiceProfile": "

The voice profile details.

", + "UpdateVoiceProfileResponse$VoiceProfile": "

The updated voice profile settings.

" } }, "VoiceProfileDomain": { - "base": null, + "base": "

A collection of voice profiles.

", "refs": { - "CreateVoiceProfileDomainResponse$VoiceProfileDomain": null, - "GetVoiceProfileDomainResponse$VoiceProfileDomain": null, - "UpdateVoiceProfileDomainResponse$VoiceProfileDomain": null + "CreateVoiceProfileDomainResponse$VoiceProfileDomain": "

The requested voice profile domain.

", + "GetVoiceProfileDomainResponse$VoiceProfileDomain": "

The details of the voice profile domain.

", + "UpdateVoiceProfileDomainResponse$VoiceProfileDomain": "

The updated details of the voice profile domain.

" } }, "VoiceProfileDomainDescription": { "base": null, "refs": { - "CreateVoiceProfileDomainRequest$Description": null, - "UpdateVoiceProfileDomainRequest$Description": null, - "VoiceProfileDomain$Description": null, - "VoiceProfileDomainSummary$Description": null + "CreateVoiceProfileDomainRequest$Description": "

A description of the voice profile domain.

", + "UpdateVoiceProfileDomainRequest$Description": "

The description of the voice profile domain.

", + "VoiceProfileDomain$Description": "

The description of the voice profile domain.

", + "VoiceProfileDomainSummary$Description": "

Describes the voice profile domain summary.

" } }, "VoiceProfileDomainName": { "base": null, "refs": { - "CreateVoiceProfileDomainRequest$Name": null, - "UpdateVoiceProfileDomainRequest$Name": null, - "VoiceProfileDomain$Name": null, - "VoiceProfileDomainSummary$Name": null + "CreateVoiceProfileDomainRequest$Name": "

The name of the voice profile domain.

", + "UpdateVoiceProfileDomainRequest$Name": "

The name of the voice profile domain.

", + "VoiceProfileDomain$Name": "

The name of the voice profile domain.

", + "VoiceProfileDomainSummary$Name": "

The name of the voice profile domain summary.

" } }, "VoiceProfileDomainSummary": { - "base": null, + "base": "

A high-level overview of a voice profile domain.

", "refs": { "VoiceProfileDomainSummaryList$member": null } @@ -2223,11 +2223,11 @@ "VoiceProfileDomainSummaryList": { "base": null, "refs": { - "ListVoiceProfileDomainsResponse$VoiceProfileDomains": null + "ListVoiceProfileDomainsResponse$VoiceProfileDomains": "

The list of voice profile domains.

" } }, "VoiceProfileSummary": { - "base": null, + "base": "

A high-level summary of a voice profile.

", "refs": { "VoiceProfileSummaryList$member": null } @@ -2235,14 +2235,14 @@ "VoiceProfileSummaryList": { "base": null, "refs": { - "ListVoiceProfilesResponse$VoiceProfiles": null + "ListVoiceProfilesResponse$VoiceProfiles": "

The list of voice profiles.

" } }, "VoiceToneAnalysisTask": { - "base": null, + "base": "

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

", "refs": { - "GetVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask": null, - "StartVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask": null + "GetVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask": "

The details of the voice tone analysis task.

", + "StartVoiceToneAnalysisTaskResponse$VoiceToneAnalysisTask": "

The details of the voice tone analysis task.

" } } } diff --git a/models/apis/chime-sdk-voice/2022-08-03/endpoint-tests-1.json b/models/apis/chime-sdk-voice/2022-08-03/endpoint-tests-1.json index e346b7807e2..ea7cfab9353 100644 --- a/models/apis/chime-sdk-voice/2022-08-03/endpoint-tests-1.json +++ b/models/apis/chime-sdk-voice/2022-08-03/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseFIPS": true } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseFIPS": true } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseFIPS": false } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseFIPS": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseFIPS": true } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseFIPS": true } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseFIPS": false } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseFIPS": false } }, { @@ -110,9 +110,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseFIPS": true } }, { @@ -123,9 +123,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseFIPS": true } }, { @@ -134,9 +134,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseFIPS": false } }, { @@ -147,9 +147,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseFIPS": false } }, { @@ -160,9 +160,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseFIPS": true } }, { @@ -173,9 +173,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseFIPS": true } }, { @@ -186,9 +186,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseFIPS": false } }, { @@ -199,9 +199,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseFIPS": false } }, { @@ -210,9 +210,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": true } }, { @@ -223,9 +223,9 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": true } }, { @@ -234,9 +234,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": false } }, { @@ -247,9 +247,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": false } }, { @@ -260,9 +260,9 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -272,9 +272,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "UseDualStack": false, "Region": "us-east-1", + "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -284,9 +284,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "UseDualStack": true, "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } } diff --git a/models/apis/connect/2017-08-08/api-2.json b/models/apis/connect/2017-08-08/api-2.json index d856a94c468..1e58c610d14 100644 --- a/models/apis/connect/2017-08-08/api-2.json +++ b/models/apis/connect/2017-08-08/api-2.json @@ -8763,7 +8763,8 @@ }, "ChatDurationInMinutes":{"shape":"ChatDurationInMinutes"}, "SupportedMessagingContentTypes":{"shape":"SupportedMessagingContentTypes"}, - "PersistentChat":{"shape":"PersistentChat"} + "PersistentChat":{"shape":"PersistentChat"}, + "RelatedContactId":{"shape":"ContactId"} } }, "StartChatContactResponse":{ diff --git a/models/apis/connect/2017-08-08/docs-2.json b/models/apis/connect/2017-08-08/docs-2.json index c743c5d9073..22ce622b35a 100644 --- a/models/apis/connect/2017-08-08/docs-2.json +++ b/models/apis/connect/2017-08-08/docs-2.json @@ -78,7 +78,7 @@ "GetCurrentUserData": "

Gets the real-time active user data from the specified Amazon Connect instance.

", "GetFederationToken": "

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

", "GetMetricData": "

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

", - "GetMetricDataV2": "

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for last the 14 days, in 24-hour intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

This API is not available in the Amazon Web Services GovCloud (US) Regions.

", + "GetMetricDataV2": "

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 14 days, in 24-hour intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

This API is not available in the Amazon Web Services GovCloud (US) Regions.

", "GetTaskTemplate": "

Gets details about a specific task template in the specified Amazon Connect instance.

", "GetTrafficDistribution": "

Retrieves the current traffic distribution for a given traffic distribution group.

", "ListAgentStatuses": "

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

", @@ -687,7 +687,7 @@ "ChatDurationInMinutes": { "base": null, "refs": { - "StartChatContactRequest$ChatDurationInMinutes": "

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

" + "StartChatContactRequest$ChatDurationInMinutes": "

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

" } }, "ChatMessage": { @@ -972,6 +972,7 @@ "PersistentChat$SourceContactId": "

The contactId from which a persistent chat session must be started.

", "ResumeContactRecordingRequest$ContactId": "

The identifier of the contact.

", "ResumeContactRecordingRequest$InitialContactId": "

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

", + "StartChatContactRequest$RelatedContactId": "

The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

You cannot provide data for both RelatedContactId and PersistentChat.

", "StartChatContactResponse$ContactId": "

The identifier of this contact within the Amazon Connect instance.

", "StartChatContactResponse$ContinuedFromContactId": "

The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

", "StartContactRecordingRequest$ContactId": "

The identifier of the contact.

", @@ -4599,7 +4600,7 @@ "SupportedMessagingContentTypes": { "base": null, "refs": { - "StartChatContactRequest$SupportedMessagingContentTypes": "

The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].

" + "StartChatContactRequest$SupportedMessagingContentTypes": "

The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

" } }, "SuspendContactRecordingRequest": { diff --git a/models/apis/connect/2017-08-08/endpoint-tests-1.json b/models/apis/connect/2017-08-08/endpoint-tests-1.json index ea61651d6f8..680921ee618 100644 --- a/models/apis/connect/2017-08-08/endpoint-tests-1.json +++ b/models/apis/connect/2017-08-08/endpoint-tests-1.json @@ -8,8 +8,8 @@ } }, "params": { - "Region": "af-south-1", "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false } }, @@ -21,8 +21,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false } }, @@ -34,8 +34,8 @@ } }, "params": { - "Region": "ap-northeast-2", "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false } }, @@ -47,8 +47,8 @@ } }, "params": { - "Region": "ap-southeast-1", "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false } }, @@ -60,8 +60,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false } }, @@ -73,8 +73,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false } }, @@ -86,8 +86,8 @@ } }, "params": { - "Region": "eu-central-1", "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false } }, @@ -99,8 +99,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false } }, @@ -112,8 +112,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false } }, @@ -125,8 +125,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false } }, @@ -138,8 +138,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true } }, @@ -151,8 +151,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true } }, @@ -164,8 +164,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false } }, @@ -177,8 +177,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -190,8 +190,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -203,8 +203,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -216,8 +216,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -229,8 +229,8 @@ } }, "params": { - "Region": "us-gov-west-1", "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false } }, @@ -242,8 +242,8 @@ } }, "params": { - "Region": "us-gov-west-1", "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true } }, @@ -255,8 +255,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -268,8 +268,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -281,8 +281,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false } }, @@ -294,11 +294,22 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false } }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -307,11 +318,22 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true } }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -320,11 +342,22 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false } }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -333,11 +366,22 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true } }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -346,8 +390,8 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false } }, @@ -359,8 +403,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -384,8 +428,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, "Endpoint": "https://example.com" } @@ -396,11 +440,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/connectparticipant/2018-09-07/docs-2.json b/models/apis/connectparticipant/2018-09-07/docs-2.json index 59c2d5f50e8..3ef442e006b 100644 --- a/models/apis/connectparticipant/2018-09-07/docs-2.json +++ b/models/apis/connectparticipant/2018-09-07/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use the Amazon Connect Participant Service to manage chat participants, such as agents and customers.

", + "service": "

Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.

Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.

", "operations": { "CompleteAttachmentUpload": "

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", "CreateParticipantConnection": "

Creates the participant's connection.

ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", @@ -66,7 +66,7 @@ "Bool": { "base": null, "refs": { - "CreateParticipantConnectionRequest$ConnectParticipant": "

Amazon Connect Participant is used to mark the participant as connected for message streaming.

" + "CreateParticipantConnectionRequest$ConnectParticipant": "

Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

" } }, "ChatContent": { @@ -74,7 +74,7 @@ "refs": { "Item$Content": "

The content of the message or event.

", "SendEventRequest$Content": "

The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

Sample Content: \"{\\\"messageId\\\":\\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\\"}\"

", - "SendMessageRequest$Content": "

The content of the message.

" + "SendMessageRequest$Content": "

The content of the message.

" } }, "ChatContentType": { @@ -82,7 +82,7 @@ "refs": { "Item$ContentType": "

The type of content of the item.

", "SendEventRequest$ContentType": "

The content type of the request. Supported types are:

", - "SendMessageRequest$ContentType": "

The type of the content. Supported types are text/plain, text/markdown, and application/json.

" + "SendMessageRequest$ContentType": "

The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

" } }, "ChatItemId": { diff --git a/models/apis/connectparticipant/2018-09-07/endpoint-rule-set-1.json b/models/apis/connectparticipant/2018-09-07/endpoint-rule-set-1.json index 239167e963f..1662572daf8 100644 --- a/models/apis/connectparticipant/2018-09-07/endpoint-rule-set-1.json +++ b/models/apis/connectparticipant/2018-09-07/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,179 +111,240 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ - "aws-us-gov", + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] } ] } ], - "endpoint": { - "url": "https://participant.connect.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://participant.connect.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -311,7 +352,7 @@ { "conditions": [], "endpoint": { - "url": "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -320,28 +361,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/connectparticipant/2018-09-07/endpoint-tests-1.json b/models/apis/connectparticipant/2018-09-07/endpoint-tests-1.json index b6732ebed46..3811e928b32 100644 --- a/models/apis/connectparticipant/2018-09-07/endpoint-tests-1.json +++ b/models/apis/connectparticipant/2018-09-07/endpoint-tests-1.json @@ -1,211 +1,244 @@ { "testCases": [ { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-gov-west-1.amazonaws.com" + "url": "https://participant.connect-fips.us-east-1.api.aws" } }, "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-west-1" + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-gov-west-1.amazonaws.com" + "url": "https://participant.connect-fips.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-west-1" + "Region": "us-east-1", + "UseFIPS": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.us-gov-east-1.api.aws" + "url": "https://participant.connect.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-east-1", + "UseFIPS": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-gov-east-1.amazonaws.com" + "url": "https://participant.connect.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-east-1", + "UseFIPS": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-gov-east-1.api.aws" + "url": "https://participant.connect-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "cn-north-1", + "UseFIPS": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-gov-east-1.amazonaws.com" + "url": "https://participant.connect-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "cn-north-1", + "UseFIPS": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.us-east-1.api.aws" + "url": "https://participant.connect.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "us-east-1" + "Region": "cn-north-1", + "UseFIPS": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.us-east-1.amazonaws.com" + "url": "https://participant.connect.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1" + "Region": "cn-north-1", + "UseFIPS": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-east-1.api.aws" + "url": "https://participant.connect.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": false, + "Region": "us-gov-west-1", + "UseFIPS": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-east-1.amazonaws.com" + "url": "https://participant.connect.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-gov-west-1", + "UseFIPS": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://participant.connect-fips.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": true, + "Region": "us-gov-east-1", + "UseFIPS": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.us-iso-east-1.c2s.ic.gov" + "url": "https://participant.connect.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-gov-east-1", + "UseFIPS": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://participant.connect.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": true, "UseDualStack": true, - "Region": "cn-north-1" + "Region": "us-gov-east-1", + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect-fips.cn-north-1.amazonaws.com.cn" + "url": "https://participant.connect.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "cn-north-1" + "Region": "us-gov-east-1", + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://participant.connect-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { "UseDualStack": true, - "Region": "cn-north-1" + "Region": "us-iso-east-1", + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://participant.connect.cn-north-1.amazonaws.com.cn" + "url": "https://participant.connect.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "cn-north-1" + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": true } }, { @@ -216,9 +249,20 @@ } }, "params": { - "UseFIPS": true, "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": false } }, { @@ -229,22 +273,35 @@ } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseFIPS": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -254,9 +311,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "UseDualStack": false, "Region": "us-east-1", + "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -266,11 +323,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "UseDualStack": true, "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/iotwireless/2020-11-22/api-2.json b/models/apis/iotwireless/2020-11-22/api-2.json index 191d2fb848c..3c6c1d42bf2 100644 --- a/models/apis/iotwireless/2020-11-22/api-2.json +++ b/models/apis/iotwireless/2020-11-22/api-2.json @@ -471,6 +471,24 @@ {"shape":"ThrottlingException"} ] }, + "DeleteWirelessDeviceImportTask":{ + "name":"DeleteWirelessDeviceImportTask", + "http":{ + "method":"DELETE", + "requestUri":"/wireless_device_import_task/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteWirelessDeviceImportTaskRequest"}, + "output":{"shape":"DeleteWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "DeleteWirelessGateway":{ "name":"DeleteWirelessGateway", "http":{ @@ -522,6 +540,21 @@ {"shape":"ThrottlingException"} ] }, + "DeregisterWirelessDevice":{ + "name":"DeregisterWirelessDevice", + "http":{ + "method":"PATCH", + "requestUri":"/wireless-devices/{Identifier}/deregister" + }, + "input":{"shape":"DeregisterWirelessDeviceRequest"}, + "output":{"shape":"DeregisterWirelessDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, "DisassociateAwsAccountFromPartnerAccount":{ "name":"DisassociateAwsAccountFromPartnerAccount", "http":{ @@ -935,6 +968,23 @@ {"shape":"ThrottlingException"} ] }, + "GetWirelessDeviceImportTask":{ + "name":"GetWirelessDeviceImportTask", + "http":{ + "method":"GET", + "requestUri":"/wireless_device_import_task/{Id}" + }, + "input":{"shape":"GetWirelessDeviceImportTaskRequest"}, + "output":{"shape":"GetWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "GetWirelessDeviceStatistics":{ "name":"GetWirelessDeviceStatistics", "http":{ @@ -1079,6 +1129,23 @@ {"shape":"ThrottlingException"} ] }, + "ListDevicesForWirelessDeviceImportTask":{ + "name":"ListDevicesForWirelessDeviceImportTask", + "http":{ + "method":"GET", + "requestUri":"/wireless_device_import_task" + }, + "input":{"shape":"ListDevicesForWirelessDeviceImportTaskRequest"}, + "output":{"shape":"ListDevicesForWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "ListEventConfigurations":{ "name":"ListEventConfigurations", "http":{ @@ -1235,6 +1302,23 @@ {"shape":"ThrottlingException"} ] }, + "ListWirelessDeviceImportTasks":{ + "name":"ListWirelessDeviceImportTasks", + "http":{ + "method":"GET", + "requestUri":"/wireless_device_import_tasks" + }, + "input":{"shape":"ListWirelessDeviceImportTasksRequest"}, + "output":{"shape":"ListWirelessDeviceImportTasksResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "ListWirelessDevices":{ "name":"ListWirelessDevices", "http":{ @@ -1454,6 +1538,42 @@ {"shape":"ThrottlingException"} ] }, + "StartSingleWirelessDeviceImportTask":{ + "name":"StartSingleWirelessDeviceImportTask", + "http":{ + "method":"POST", + "requestUri":"/wireless_single_device_import_task", + "responseCode":201 + }, + "input":{"shape":"StartSingleWirelessDeviceImportTaskRequest"}, + "output":{"shape":"StartSingleWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, + "StartWirelessDeviceImportTask":{ + "name":"StartWirelessDeviceImportTask", + "http":{ + "method":"POST", + "requestUri":"/wireless_device_import_task", + "responseCode":201 + }, + "input":{"shape":"StartWirelessDeviceImportTaskRequest"}, + "output":{"shape":"StartWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -1696,6 +1816,24 @@ {"shape":"ThrottlingException"} ] }, + "UpdateWirelessDeviceImportTask":{ + "name":"UpdateWirelessDeviceImportTask", + "http":{ + "method":"PATCH", + "requestUri":"/wireless_device_import_task/{Id}", + "responseCode":204 + }, + "input":{"shape":"UpdateWirelessDeviceImportTaskRequest"}, + "output":{"shape":"UpdateWirelessDeviceImportTaskResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "UpdateWirelessGateway":{ "name":"UpdateWirelessGateway", "http":{ @@ -1762,6 +1900,10 @@ "max":1011, "min":1 }, + "ApId":{ + "type":"string", + "max":256 + }, "AppEui":{ "type":"string", "pattern":"[a-fA-F0-9]{16}" @@ -1793,6 +1935,13 @@ "type":"string", "enum":["SemtechGeolocation"] }, + "ApplicationServerPublicKey":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"[a-fA-F0-9]{64}", + "sensitive":true + }, "Applications":{ "type":"list", "member":{"shape":"ApplicationConfig"} @@ -2207,7 +2356,8 @@ "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true - } + }, + "Sidewalk":{"shape":"SidewalkCreateDeviceProfile"} } }, "CreateDeviceProfileResponse":{ @@ -2326,7 +2476,8 @@ }, "LoRaWAN":{"shape":"LoRaWANDevice"}, "Tags":{"shape":"TagList"}, - "Positioning":{"shape":"PositioningConfigStatus"} + "Positioning":{"shape":"PositioningConfigStatus"}, + "Sidewalk":{"shape":"SidewalkCreateWirelessDevice"} } }, "CreateWirelessDeviceResponse":{ @@ -2402,6 +2553,29 @@ }, "CreatedAt":{"type":"timestamp"}, "CreationDate":{"type":"timestamp"}, + "CreationTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "DakCertificateId":{ + "type":"string", + "max":256 + }, + "DakCertificateMetadata":{ + "type":"structure", + "required":["CertificateId"], + "members":{ + "CertificateId":{"shape":"DakCertificateId"}, + "MaxAllowedSignature":{"shape":"MaxAllowedSignature"}, + "FactorySupport":{"shape":"FactorySupport"}, + "ApId":{"shape":"ApId"}, + "DeviceTypeId":{"shape":"DeviceTypeId"} + } + }, + "DakCertificateMetadataList":{ + "type":"list", + "member":{"shape":"DakCertificateMetadata"} + }, "DeleteDestinationRequest":{ "type":"structure", "required":["Name"], @@ -2527,6 +2701,22 @@ "members":{ } }, + "DeleteWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ImportTaskId", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteWirelessDeviceRequest":{ "type":"structure", "required":["Id"], @@ -2591,6 +2781,27 @@ "members":{ } }, + "DeregisterWirelessDeviceRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"Identifier", + "location":"uri", + "locationName":"Identifier" + }, + "WirelessDeviceType":{ + "shape":"WirelessDeviceType", + "location":"querystring", + "locationName":"WirelessDeviceType" + } + } + }, + "DeregisterWirelessDeviceResponse":{ + "type":"structure", + "members":{ + } + }, "Description":{ "type":"string", "max":2048 @@ -2633,6 +2844,15 @@ "type":"list", "member":{"shape":"CertificateList"} }, + "DeviceCreationFile":{ + "type":"string", + "max":1024 + }, + "DeviceCreationFileList":{ + "type":"list", + "member":{"shape":"DeviceCreationFile"} + }, + "DeviceName":{"type":"string"}, "DeviceProfile":{ "type":"structure", "members":{ @@ -2654,6 +2874,13 @@ "type":"string", "max":256 }, + "DeviceProfileType":{ + "type":"string", + "enum":[ + "Sidewalk", + "LoRaWAN" + ] + }, "DeviceRegistrationStateEventConfiguration":{ "type":"structure", "members":{ @@ -2676,6 +2903,10 @@ "RegisteredUnreachable" ] }, + "DeviceTypeId":{ + "type":"string", + "max":2048 + }, "DisassociateAwsAccountFromPartnerAccountRequest":{ "type":"structure", "required":[ @@ -3007,6 +3238,7 @@ "max":20, "min":0 }, + "FactorySupport":{"type":"boolean"}, "Fingerprint":{ "type":"string", "max":64, @@ -3151,7 +3383,8 @@ "Arn":{"shape":"DeviceProfileArn"}, "Name":{"shape":"DeviceProfileName"}, "Id":{"shape":"DeviceProfileId"}, - "LoRaWAN":{"shape":"LoRaWANDeviceProfile"} + "LoRaWAN":{"shape":"LoRaWANDeviceProfile"}, + "Sidewalk":{"shape":"SidewalkGetDeviceProfile"} } }, "GetEventConfigurationByResourceTypesRequest":{ @@ -3502,6 +3735,33 @@ "LoRaWAN":{"shape":"LoRaWANGetServiceProfileInfo"} } }, + "GetWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ImportTaskId", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + "Id":{"shape":"ImportTaskId"}, + "Arn":{"shape":"ImportTaskArn"}, + "DestinationName":{"shape":"DestinationName"}, + "Sidewalk":{"shape":"SidewalkGetStartImportInfo"}, + "CreationTime":{"shape":"CreationTime"}, + "Status":{"shape":"ImportTaskStatus"}, + "StatusReason":{"shape":"StatusReason"}, + "InitializedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "PendingImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "OnboardedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "FailedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"} + } + }, "GetWirelessDeviceRequest":{ "type":"structure", "required":[ @@ -3794,6 +4054,45 @@ "WirelessGatewayId" ] }, + "ImportTaskArn":{ + "type":"string", + "max":128 + }, + "ImportTaskId":{ + "type":"string", + "max":256 + }, + "ImportTaskStatus":{ + "type":"string", + "enum":[ + "INITIALIZING", + "INITIALIZED", + "PENDING", + "COMPLETE", + "FAILED", + "DELETING" + ] + }, + "ImportedSidewalkDevice":{ + "type":"structure", + "members":{ + "SidewalkManufacturingSn":{"shape":"SidewalkManufacturingSn"}, + "OnboardingStatus":{"shape":"OnboardStatus"}, + "OnboardingStatusReason":{"shape":"OnboardStatusReason"}, + "LastUpdateTime":{"shape":"LastUpdateTime"} + } + }, + "ImportedWirelessDevice":{ + "type":"structure", + "members":{ + "Sidewalk":{"shape":"ImportedSidewalkDevice"} + } + }, + "ImportedWirelessDeviceCount":{"type":"long"}, + "ImportedWirelessDeviceList":{ + "type":"list", + "member":{"shape":"ImportedWirelessDevice"} + }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", @@ -3849,6 +4148,10 @@ "max":65535, "min":1 }, + "LastUpdateTime":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, "ListDestinationsRequest":{ "type":"structure", "members":{ @@ -3883,6 +4186,11 @@ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" + }, + "DeviceProfileType":{ + "shape":"DeviceProfileType", + "location":"querystring", + "locationName":"deviceProfileType" } } }, @@ -3893,6 +4201,40 @@ "DeviceProfileList":{"shape":"DeviceProfileList"} } }, + "ListDevicesForWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ImportTaskId", + "location":"querystring", + "locationName":"id" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "Status":{ + "shape":"OnboardStatus", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListDevicesForWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "DestinationName":{"shape":"DestinationName"}, + "ImportedWirelessDeviceList":{"shape":"ImportedWirelessDeviceList"} + } + }, "ListEventConfigurationsRequest":{ "type":"structure", "required":["ResourceType"], @@ -4140,6 +4482,28 @@ "Tags":{"shape":"TagList"} } }, + "ListWirelessDeviceImportTasksRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListWirelessDeviceImportTasksResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "WirelessDeviceImportTaskList":{"shape":"WirelessDeviceImportTaskList"} + } + }, "ListWirelessDevicesRequest":{ "type":"structure", "members":{ @@ -4562,6 +4926,7 @@ "type":"string", "max":64 }, + "MaxAllowedSignature":{"type":"integer"}, "MaxDutyCycle":{ "type":"integer", "max":100, @@ -4727,6 +5092,16 @@ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, + "OnboardStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "PENDING", + "ONBOARDED", + "FAILED" + ] + }, + "OnboardStatusReason":{"type":"string"}, "OtaaV1_0_x":{ "type":"structure", "members":{ @@ -4904,6 +5279,10 @@ "max":16700000, "min":1000000 }, + "PrivateKeysList":{ + "type":"list", + "member":{"shape":"CertificateList"} + }, "ProximityEventConfiguration":{ "type":"structure", "members":{ @@ -4973,6 +5352,7 @@ "members":{ } }, + "QualificationStatus":{"type":"boolean"}, "QueryString":{ "type":"string", "max":4096 @@ -5072,6 +5452,10 @@ "type":"string", "max":64 }, + "Role":{ + "type":"string", + "max":2048 + }, "RoleArn":{ "type":"string", "max":2048, @@ -5243,13 +5627,28 @@ "type":"list", "member":{"shape":"SidewalkAccountInfoWithFingerprint"} }, + "SidewalkCreateDeviceProfile":{ + "type":"structure", + "members":{ + } + }, + "SidewalkCreateWirelessDevice":{ + "type":"structure", + "members":{ + "DeviceProfileId":{"shape":"DeviceProfileId"} + } + }, "SidewalkDevice":{ "type":"structure", "members":{ "AmazonId":{"shape":"AmazonId"}, "SidewalkId":{"shape":"SidewalkId"}, "SidewalkManufacturingSn":{"shape":"SidewalkManufacturingSn"}, - "DeviceCertificates":{"shape":"DeviceCertificateList"} + "DeviceCertificates":{"shape":"DeviceCertificateList"}, + "PrivateKeys":{"shape":"PrivateKeysList"}, + "DeviceProfileId":{"shape":"DeviceProfileId"}, + "CertificateId":{"shape":"DakCertificateId"}, + "Status":{"shape":"WirelessDeviceSidewalkStatus"} } }, "SidewalkDeviceMetadata":{ @@ -5267,6 +5666,21 @@ "AmazonIdEventTopic":{"shape":"EventNotificationTopicStatus"} } }, + "SidewalkGetDeviceProfile":{ + "type":"structure", + "members":{ + "ApplicationServerPublicKey":{"shape":"ApplicationServerPublicKey"}, + "QualificationStatus":{"shape":"QualificationStatus"}, + "DakCertificateMetadata":{"shape":"DakCertificateMetadataList"} + } + }, + "SidewalkGetStartImportInfo":{ + "type":"structure", + "members":{ + "DeviceCreationFileList":{"shape":"DeviceCreationFileList"}, + "Role":{"shape":"Role"} + } + }, "SidewalkId":{ "type":"string", "max":256 @@ -5277,7 +5691,9 @@ "AmazonId":{"shape":"AmazonId"}, "SidewalkId":{"shape":"SidewalkId"}, "SidewalkManufacturingSn":{"shape":"SidewalkManufacturingSn"}, - "DeviceCertificates":{"shape":"DeviceCertificateList"} + "DeviceCertificates":{"shape":"DeviceCertificateList"}, + "DeviceProfileId":{"shape":"DeviceProfileId"}, + "Status":{"shape":"WirelessDeviceSidewalkStatus"} } }, "SidewalkManufacturingSn":{ @@ -5298,12 +5714,31 @@ "AckModeRetryDurationSecs":{"shape":"AckModeRetryDurationSecs"} } }, + "SidewalkSingleStartImportInfo":{ + "type":"structure", + "members":{ + "SidewalkManufacturingSn":{"shape":"SidewalkManufacturingSn"} + } + }, + "SidewalkStartImportInfo":{ + "type":"structure", + "members":{ + "DeviceCreationFile":{"shape":"DeviceCreationFile"}, + "Role":{"shape":"Role"} + } + }, "SidewalkUpdateAccount":{ "type":"structure", "members":{ "AppServerPrivateKey":{"shape":"AppServerPrivateKey"} } }, + "SidewalkUpdateImportInfo":{ + "type":"structure", + "members":{ + "DeviceCreationFile":{"shape":"DeviceCreationFile"} + } + }, "SigningAlg":{ "type":"string", "enum":[ @@ -5384,15 +5819,63 @@ "members":{ } }, + "StartSingleWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":[ + "DestinationName", + "Sidewalk" + ], + "members":{ + "DestinationName":{"shape":"DestinationName"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "DeviceName":{"shape":"DeviceName"}, + "Tags":{"shape":"TagList"}, + "Sidewalk":{"shape":"SidewalkSingleStartImportInfo"} + } + }, + "StartSingleWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + "Id":{"shape":"ImportTaskId"}, + "Arn":{"shape":"ImportTaskArn"} + } + }, "StartTime":{ "type":"timestamp", "timestampFormat":"iso8601" }, + "StartWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":[ + "DestinationName", + "Sidewalk" + ], + "members":{ + "DestinationName":{"shape":"DestinationName"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Tags":{"shape":"TagList"}, + "Sidewalk":{"shape":"SidewalkStartImportInfo"} + } + }, + "StartWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + "Id":{"shape":"ImportTaskId"}, + "Arn":{"shape":"ImportTaskArn"} + } + }, "Station":{ "type":"string", "max":4096, "min":1 }, + "StatusReason":{"type":"string"}, "SubBand":{ "type":"integer", "max":8, @@ -5410,7 +5893,16 @@ "EU868", "US915", "AU915", - "AS923-1" + "AS923-1", + "AS923-2", + "AS923-3", + "AS923-4", + "EU433", + "CN470", + "CN779", + "RU864", + "KR920", + "IN865" ] }, "Supports32BitFCnt":{"type":"boolean"}, @@ -5905,6 +6397,26 @@ "max":4096, "min":1 }, + "UpdateWirelessDeviceImportTaskRequest":{ + "type":"structure", + "required":[ + "Id", + "Sidewalk" + ], + "members":{ + "Id":{ + "shape":"ImportTaskId", + "location":"uri", + "locationName":"Id" + }, + "Sidewalk":{"shape":"SidewalkUpdateImportInfo"} + } + }, + "UpdateWirelessDeviceImportTaskResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateWirelessDeviceRequest":{ "type":"structure", "required":["Id"], @@ -6097,6 +6609,26 @@ "SidewalkManufacturingSn" ] }, + "WirelessDeviceImportTask":{ + "type":"structure", + "members":{ + "Id":{"shape":"ImportTaskId"}, + "Arn":{"shape":"ImportTaskArn"}, + "DestinationName":{"shape":"DestinationName"}, + "Sidewalk":{"shape":"SidewalkGetStartImportInfo"}, + "CreationTime":{"shape":"CreationTime"}, + "Status":{"shape":"ImportTaskStatus"}, + "StatusReason":{"shape":"StatusReason"}, + "InitializedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "PendingImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "OnboardedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"}, + "FailedImportedDeviceCount":{"shape":"ImportedWirelessDeviceCount"} + } + }, + "WirelessDeviceImportTaskList":{ + "type":"list", + "member":{"shape":"WirelessDeviceImportTask"} + }, "WirelessDeviceList":{ "type":"list", "member":{"shape":"WirelessDeviceId"}, @@ -6123,6 +6655,15 @@ "type":"string", "max":256 }, + "WirelessDeviceSidewalkStatus":{ + "type":"string", + "enum":[ + "PROVISIONED", + "REGISTERED", + "ACTIVATED", + "UNKNOWN" + ] + }, "WirelessDeviceStatistics":{ "type":"structure", "members":{ diff --git a/models/apis/iotwireless/2020-11-22/docs-2.json b/models/apis/iotwireless/2020-11-22/docs-2.json index 5380f57d4f2..4e4a6e9d59b 100644 --- a/models/apis/iotwireless/2020-11-22/docs-2.json +++ b/models/apis/iotwireless/2020-11-22/docs-2.json @@ -28,9 +28,11 @@ "DeleteQueuedMessages": "

Remove queued messages from the downlink queue.

", "DeleteServiceProfile": "

Deletes a service profile.

", "DeleteWirelessDevice": "

Deletes a wireless device.

", + "DeleteWirelessDeviceImportTask": "

Delete an import task.

", "DeleteWirelessGateway": "

Deletes a wireless gateway.

", "DeleteWirelessGatewayTask": "

Deletes a wireless gateway task.

", "DeleteWirelessGatewayTaskDefinition": "

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

", + "DeregisterWirelessDevice": "

Deregister a wireless device from AWS IoT Wireless.

", "DisassociateAwsAccountFromPartnerAccount": "

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

", "DisassociateMulticastGroupFromFuotaTask": "

Disassociates a multicast group from a fuota task.

", "DisassociateWirelessDeviceFromFuotaTask": "

Disassociates a wireless device from a FUOTA task.

", @@ -56,6 +58,7 @@ "GetServiceEndpoint": "

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

", "GetServiceProfile": "

Gets information about a service profile.

", "GetWirelessDevice": "

Gets information about a wireless device.

", + "GetWirelessDeviceImportTask": "

Get information about an import task and count of device onboarding summary information for the import task.

", "GetWirelessDeviceStatistics": "

Gets operating information about a wireless device.

", "GetWirelessGateway": "

Gets information about a wireless gateway.

", "GetWirelessGatewayCertificate": "

Gets the ID of the certificate that is currently associated with a wireless gateway.

", @@ -65,6 +68,7 @@ "GetWirelessGatewayTaskDefinition": "

Gets information about a wireless gateway task definition.

", "ListDestinations": "

Lists the destinations registered to your AWS account.

", "ListDeviceProfiles": "

Lists the device profiles registered to your AWS account.

", + "ListDevicesForWirelessDeviceImportTask": "

List the Sidewalk devices in an import task and their onboarding status.

", "ListEventConfigurations": "

List event configurations where at least one event topic has been enabled.

", "ListFuotaTasks": "

Lists the FUOTA tasks registered to your AWS account.

", "ListMulticastGroups": "

Lists the multicast groups registered to your AWS account.

", @@ -75,6 +79,7 @@ "ListQueuedMessages": "

List queued messages in the downlink queue.

", "ListServiceProfiles": "

Lists the service profiles registered to your AWS account.

", "ListTagsForResource": "

Lists the tags (metadata) you have assigned to the resource.

", + "ListWirelessDeviceImportTasks": "

List wireless devices that have been added to an import task.

", "ListWirelessDevices": "

Lists the wireless devices registered to your AWS account.

", "ListWirelessGatewayTaskDefinitions": "

List the wireless gateway tasks definitions registered to your AWS account.

", "ListWirelessGateways": "

Lists the wireless gateways registered to your AWS account.

", @@ -88,6 +93,8 @@ "StartBulkDisassociateWirelessDeviceFromMulticastGroup": "

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

", "StartFuotaTask": "

Starts a FUOTA task.

", "StartMulticastGroupSession": "

Starts a multicast group session.

", + "StartSingleWirelessDeviceImportTask": "

Start import task for a single wireless device.

", + "StartWirelessDeviceImportTask": "

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

", "TagResource": "

Adds a tag to a resource.

", "TestWirelessDevice": "

Simulates a provisioned device by sending an uplink data payload of Hello.

", "UntagResource": "

Removes one or more tags from a resource.

", @@ -102,6 +109,7 @@ "UpdateResourceEventConfiguration": "

Update the event configuration for a particular resource identifier.

", "UpdateResourcePosition": "

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).

", "UpdateWirelessDevice": "

Updates properties of a wireless device.

", + "UpdateWirelessDeviceImportTask": "

Update an import task to add more devices to the task.

", "UpdateWirelessGateway": "

Updates properties of a wireless gateway.

" }, "shapes": { @@ -165,6 +173,12 @@ "UntagResourceRequest$ResourceArn": "

The ARN of the resource to remove tags from.

" } }, + "ApId": { + "base": null, + "refs": { + "DakCertificateMetadata$ApId": "

The advertised product ID (APID) that's used for pre-production and production applications.

" + } + }, "AppEui": { "base": null, "refs": { @@ -204,6 +218,12 @@ "ApplicationConfig$Type": "

Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

" } }, + "ApplicationServerPublicKey": { + "base": null, + "refs": { + "SidewalkGetDeviceProfile$ApplicationServerPublicKey": "

The Sidewalk application server public key.

" + } + }, "Applications": { "base": null, "refs": { @@ -426,7 +446,8 @@ "CertificateList": { "base": "

List of sidewalk certificates.

", "refs": { - "DeviceCertificateList$member": null + "DeviceCertificateList$member": null, + "PrivateKeysList$member": null } }, "CertificatePEM": { @@ -471,7 +492,9 @@ "CreateServiceProfileRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "CreateWirelessDeviceRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "CreateWirelessGatewayRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", - "CreateWirelessGatewayTaskDefinitionRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

" + "CreateWirelessGatewayTaskDefinitionRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "StartSingleWirelessDeviceImportTaskRequest$ClientRequestToken": null, + "StartWirelessDeviceImportTaskRequest$ClientRequestToken": null } }, "ConflictException": { @@ -626,6 +649,32 @@ "GetPositionEstimateRequest$Timestamp": "

Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

" } }, + "CreationTime": { + "base": null, + "refs": { + "GetWirelessDeviceImportTaskResponse$CreationTime": "

The time at which the import task was created.

", + "WirelessDeviceImportTask$CreationTime": "

The time at which the import task was created.

" + } + }, + "DakCertificateId": { + "base": null, + "refs": { + "DakCertificateMetadata$CertificateId": "

The certificate ID for the DAK.

", + "SidewalkDevice$CertificateId": "

The ID of the Sidewalk device profile.

" + } + }, + "DakCertificateMetadata": { + "base": "

The device attestation key (DAK) information.

", + "refs": { + "DakCertificateMetadataList$member": null + } + }, + "DakCertificateMetadataList": { + "base": null, + "refs": { + "SidewalkGetDeviceProfile$DakCertificateMetadata": "

The DAK certificate information of the Sidewalk device profile.

" + } + }, "DeleteDestinationRequest": { "base": null, "refs": { @@ -696,6 +745,16 @@ "refs": { } }, + "DeleteWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "DeleteWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "DeleteWirelessDeviceRequest": { "base": null, "refs": { @@ -736,6 +795,16 @@ "refs": { } }, + "DeregisterWirelessDeviceRequest": { + "base": null, + "refs": { + } + }, + "DeregisterWirelessDeviceResponse": { + "base": null, + "refs": { + } + }, "Description": { "base": "

The description of the new resource.

", "refs": { @@ -787,12 +856,17 @@ "GetDestinationRequest$Name": "

The name of the resource to get.

", "GetDestinationResponse$Name": "

The name of the resource.

", "GetPositionConfigurationResponse$Destination": "

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

", + "GetWirelessDeviceImportTaskResponse$DestinationName": "

The name of the destination that's assigned to the wireless devices in the import task.

", "GetWirelessDeviceResponse$DestinationName": "

The name of the destination to which the device is assigned.

", + "ListDevicesForWirelessDeviceImportTaskResponse$DestinationName": "

The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

", "ListWirelessDevicesRequest$DestinationName": "

A filter to list only the wireless devices that use this destination.

", "PositionConfigurationItem$Destination": "

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

", "PutPositionConfigurationRequest$Destination": "

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

", + "StartSingleWirelessDeviceImportTaskRequest$DestinationName": "

The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

", + "StartWirelessDeviceImportTaskRequest$DestinationName": "

The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.

", "UpdateDestinationRequest$Name": "

The new name of the resource.

", "UpdateWirelessDeviceRequest$DestinationName": "

The name of the new destination for the device.

", + "WirelessDeviceImportTask$DestinationName": "

The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless

", "WirelessDeviceStatistics$DestinationName": "

The name of the destination to which the device is assigned.

" } }, @@ -830,6 +904,26 @@ "SidewalkListDevice$DeviceCertificates": "

The sidewalk device certificates for Ed25519 and P256r1.

" } }, + "DeviceCreationFile": { + "base": null, + "refs": { + "DeviceCreationFileList$member": null, + "SidewalkStartImportInfo$DeviceCreationFile": "

The CSV file contained in an S3 bucket that's used for adding devices to an import task.

", + "SidewalkUpdateImportInfo$DeviceCreationFile": "

The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.

" + } + }, + "DeviceCreationFileList": { + "base": null, + "refs": { + "SidewalkGetStartImportInfo$DeviceCreationFileList": "

List of Sidewalk devices that are added to the import task.

" + } + }, + "DeviceName": { + "base": null, + "refs": { + "StartSingleWirelessDeviceImportTaskRequest$DeviceName": "

The name of the wireless device for which an import task is being started.

" + } + }, "DeviceProfile": { "base": "

Describes a device profile.

", "refs": { @@ -854,7 +948,10 @@ "GetDeviceProfileResponse$Id": "

The ID of the device profile.

", "ListWirelessDevicesRequest$DeviceProfileId": "

A filter to list only the wireless devices that use this device profile.

", "LoRaWANDevice$DeviceProfileId": "

The ID of the device profile for the new wireless device.

", - "LoRaWANUpdateDevice$DeviceProfileId": "

The ID of the device profile for the wireless device.

" + "LoRaWANUpdateDevice$DeviceProfileId": "

The ID of the device profile for the wireless device.

", + "SidewalkCreateWirelessDevice$DeviceProfileId": "

The ID of the Sidewalk device profile.

", + "SidewalkDevice$DeviceProfileId": "

The ID of the Sidewalk device profile.

", + "SidewalkListDevice$DeviceProfileId": "

Sidewalk object used by list functions.

" } }, "DeviceProfileList": { @@ -871,6 +968,12 @@ "GetDeviceProfileResponse$Name": "

The name of the resource.

" } }, + "DeviceProfileType": { + "base": null, + "refs": { + "ListDeviceProfilesRequest$DeviceProfileType": "

A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.

" + } + }, "DeviceRegistrationStateEventConfiguration": { "base": "

Device registration state event configuration object for enabling and disabling relevant topics.

", "refs": { @@ -892,6 +995,12 @@ "SidewalkDeviceMetadata$DeviceState": "

Device state defines the device status of sidewalk device.

" } }, + "DeviceTypeId": { + "base": null, + "refs": { + "DakCertificateMetadata$DeviceTypeId": "

The device type ID that's used for prototyping applications.

" + } + }, "DisassociateAwsAccountFromPartnerAccountRequest": { "base": null, "refs": { @@ -1187,6 +1296,12 @@ "LoRaWANDeviceProfile$FactoryPresetFreqsList": "

The list of values that make up the FactoryPresetFreqs value.

" } }, + "FactorySupport": { + "base": null, + "refs": { + "DakCertificateMetadata$FactorySupport": "

Whether factory support has been enabled.

" + } + }, "Fingerprint": { "base": null, "refs": { @@ -1500,6 +1615,16 @@ "refs": { } }, + "GetWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "GetWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "GetWirelessDeviceRequest": { "base": null, "refs": { @@ -1669,6 +1794,7 @@ "Identifier": { "base": null, "refs": { + "DeregisterWirelessDeviceRequest$Identifier": "

The identifier of the wireless device to deregister from AWS IoT Wireless.

", "EventConfigurationItem$Identifier": "

Resource identifier opted in for event messaging.

", "GetResourceEventConfigurationRequest$Identifier": "

Resource identifier to opt in for event messaging.

", "GetWirelessDeviceRequest$Identifier": "

The identifier of the wireless device to get.

", @@ -1684,6 +1810,66 @@ "UpdateResourceEventConfigurationRequest$IdentifierType": "

Identifier type of the particular resource identifier for event configuration.

" } }, + "ImportTaskArn": { + "base": null, + "refs": { + "GetWirelessDeviceImportTaskResponse$Arn": "

The ARN (Amazon Resource Name) of the import task.

", + "StartSingleWirelessDeviceImportTaskResponse$Arn": "

The ARN (Amazon Resource Name) of the import task.

", + "StartWirelessDeviceImportTaskResponse$Arn": "

The ARN (Amazon Resource Name) of the import task.

", + "WirelessDeviceImportTask$Arn": "

The ARN (Amazon Resource Name) of the wireless device import task.

" + } + }, + "ImportTaskId": { + "base": null, + "refs": { + "DeleteWirelessDeviceImportTaskRequest$Id": "

The unique identifier of the import task to be deleted.

", + "GetWirelessDeviceImportTaskRequest$Id": "

The identifier of the import task for which information is requested.

", + "GetWirelessDeviceImportTaskResponse$Id": "

The identifier of the import task for which information is retrieved.

", + "ListDevicesForWirelessDeviceImportTaskRequest$Id": "

The identifier of the import task for which wireless devices are listed.

", + "StartSingleWirelessDeviceImportTaskResponse$Id": "

The import task ID.

", + "StartWirelessDeviceImportTaskResponse$Id": "

The import task ID.

", + "UpdateWirelessDeviceImportTaskRequest$Id": "

The identifier of the import task to be updated.

", + "WirelessDeviceImportTask$Id": "

The ID of the wireless device import task.

" + } + }, + "ImportTaskStatus": { + "base": null, + "refs": { + "GetWirelessDeviceImportTaskResponse$Status": "

The import task status.

", + "WirelessDeviceImportTask$Status": "

The status information of the wireless device import task.

" + } + }, + "ImportedSidewalkDevice": { + "base": "

Information about a Sidewalk device that has been added to an import task.

", + "refs": { + "ImportedWirelessDevice$Sidewalk": "

The Sidewalk-related information about a device that has been added to an import task.

" + } + }, + "ImportedWirelessDevice": { + "base": "

Information about a wireless device that has been added to an import task.

", + "refs": { + "ImportedWirelessDeviceList$member": null + } + }, + "ImportedWirelessDeviceCount": { + "base": null, + "refs": { + "GetWirelessDeviceImportTaskResponse$InitializedImportedDeviceCount": "

The number of devices in the import task that are waiting for the control log to start processing.

", + "GetWirelessDeviceImportTaskResponse$PendingImportedDeviceCount": "

The number of devices in the import task that are waiting in the import task queue to be onboarded.

", + "GetWirelessDeviceImportTaskResponse$OnboardedImportedDeviceCount": "

The number of devices in the import task that have been onboarded to the import task.

", + "GetWirelessDeviceImportTaskResponse$FailedImportedDeviceCount": "

The number of devices in the import task that failed to onboard to the import task.

", + "WirelessDeviceImportTask$InitializedImportedDeviceCount": "

The summary information of count of wireless devices that are waiting for the control log to be added to an import task.

", + "WirelessDeviceImportTask$PendingImportedDeviceCount": "

The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.

", + "WirelessDeviceImportTask$OnboardedImportedDeviceCount": "

The summary information of count of wireless devices in an import task that have been onboarded to the import task.

", + "WirelessDeviceImportTask$FailedImportedDeviceCount": "

The summary information of count of wireless devices in an import task that failed to onboarded to the import task.

" + } + }, + "ImportedWirelessDeviceList": { + "base": null, + "refs": { + "ListDevicesForWirelessDeviceImportTaskResponse$ImportedWirelessDeviceList": "

List of wireless devices in an import task and their onboarding status.

" + } + }, "Integer": { "base": null, "refs": { @@ -1757,6 +1943,12 @@ "WcdmaObj$Lac": "

Location Area Code.

" } }, + "LastUpdateTime": { + "base": null, + "refs": { + "ImportedSidewalkDevice$LastUpdateTime": "

The time at which the status information was last updated.

" + } + }, "ListDestinationsRequest": { "base": null, "refs": { @@ -1777,6 +1969,16 @@ "refs": { } }, + "ListDevicesForWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "ListDevicesForWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "ListEventConfigurationsRequest": { "base": null, "refs": { @@ -1877,6 +2079,16 @@ "refs": { } }, + "ListWirelessDeviceImportTasksRequest": { + "base": null, + "refs": { + } + }, + "ListWirelessDeviceImportTasksResponse": { + "base": null, + "refs": { + } + }, "ListWirelessDevicesRequest": { "base": null, "refs": { @@ -2155,6 +2367,12 @@ "LoRaWANDeviceProfile$MacVersion": "

The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

" } }, + "MaxAllowedSignature": { + "base": null, + "refs": { + "DakCertificateMetadata$MaxAllowedSignature": "

The maximum number of signatures that the DAK can sign. A value of -1 indicates that there's no device limit.

" + } + }, "MaxDutyCycle": { "base": null, "refs": { @@ -2172,6 +2390,7 @@ "refs": { "ListDestinationsRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListDeviceProfilesRequest$MaxResults": "

The maximum number of results to return in this operation.

", + "ListDevicesForWirelessDeviceImportTaskRequest$MaxResults": null, "ListEventConfigurationsRequest$MaxResults": null, "ListFuotaTasksRequest$MaxResults": null, "ListMulticastGroupsByFuotaTaskRequest$MaxResults": null, @@ -2181,6 +2400,7 @@ "ListPositionConfigurationsRequest$MaxResults": null, "ListQueuedMessagesRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListServiceProfilesRequest$MaxResults": "

The maximum number of results to return in this operation.

", + "ListWirelessDeviceImportTasksRequest$MaxResults": null, "ListWirelessDevicesRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListWirelessGatewayTaskDefinitionsRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListWirelessGatewaysRequest$MaxResults": "

The maximum number of results to return in this operation.

" @@ -2397,6 +2617,8 @@ "ListDestinationsResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", "ListDeviceProfilesRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListDeviceProfilesResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", + "ListDevicesForWirelessDeviceImportTaskRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "ListDevicesForWirelessDeviceImportTaskResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", "ListEventConfigurationsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListEventConfigurationsResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListFuotaTasksRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", @@ -2415,6 +2637,8 @@ "ListQueuedMessagesResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListServiceProfilesRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListServiceProfilesResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", + "ListWirelessDeviceImportTasksRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "ListWirelessDeviceImportTasksResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", "ListWirelessDevicesRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListWirelessDevicesResponse$NextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", "ListWirelessGatewayTaskDefinitionsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", @@ -2459,6 +2683,19 @@ "SessionKeysAbpV1_0_x$NwkSKey": "

The NwkSKey value.

" } }, + "OnboardStatus": { + "base": null, + "refs": { + "ImportedSidewalkDevice$OnboardingStatus": "

The onboarding status of the Sidewalk device in the import task.

", + "ListDevicesForWirelessDeviceImportTaskRequest$Status": "

The status of the devices in the import task.

" + } + }, + "OnboardStatusReason": { + "base": null, + "refs": { + "ImportedSidewalkDevice$OnboardingStatusReason": "

The reason for the onboarding status information for the Sidewalk device.

" + } + }, "OtaaV1_0_x": { "base": "

OTAA device object for v1.0.x

", "refs": { @@ -2692,6 +2929,12 @@ "FactoryPresetFreqsList$member": null } }, + "PrivateKeysList": { + "base": null, + "refs": { + "SidewalkDevice$PrivateKeys": "

The Sidewalk device private keys that will be used for onboarding the device.

" + } + }, "ProximityEventConfiguration": { "base": "

Proximity event configuration object for enabling and disabling relevant topics.

", "refs": { @@ -2727,6 +2970,12 @@ "refs": { } }, + "QualificationStatus": { + "base": null, + "refs": { + "SidewalkGetDeviceProfile$QualificationStatus": "

Gets information about the certification status of a Sidewalk device profile.

" + } + }, "QueryString": { "base": "

Query string used to search for wireless devices as part of the bulk associate and disassociate process.

", "refs": { @@ -2760,7 +3009,7 @@ "RSS": { "base": null, "refs": { - "WiFiAccessPoint$Rss": "

Recived signal strength of the WLAN measurement data.

" + "WiFiAccessPoint$Rss": "

Received signal strength (dBm) of the WLAN measurement data.

" } }, "RaAllowed": { @@ -2865,6 +3114,13 @@ "LoRaWANGateway$RfRegion": "

The frequency band (RFRegion) value.

" } }, + "Role": { + "base": null, + "refs": { + "SidewalkGetStartImportInfo$Role": "

The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

", + "SidewalkStartImportInfo$Role": "

The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

" + } + }, "RoleArn": { "base": null, "refs": { @@ -3034,6 +3290,18 @@ "ListPartnerAccountsResponse$Sidewalk": "

The Sidewalk account credentials.

" } }, + "SidewalkCreateDeviceProfile": { + "base": "

Sidewalk object for creating a device profile.

", + "refs": { + "CreateDeviceProfileRequest$Sidewalk": "

The Sidewalk-related information for creating the Sidewalk device profile.

" + } + }, + "SidewalkCreateWirelessDevice": { + "base": "

Sidewalk object for creating a wireless device.

", + "refs": { + "CreateWirelessDeviceRequest$Sidewalk": "

The device configuration information to use to create the Sidewalk device.

" + } + }, "SidewalkDevice": { "base": "

Sidewalk device object.

", "refs": { @@ -3054,6 +3322,19 @@ "ProximityEventConfiguration$Sidewalk": "

Proximity event configuration object for enabling or disabling Sidewalk related event topics.

" } }, + "SidewalkGetDeviceProfile": { + "base": "

Gets information about a Sidewalk device profile.

", + "refs": { + "GetDeviceProfileResponse$Sidewalk": "

Information about the Sidewalk parameters in the device profile.

" + } + }, + "SidewalkGetStartImportInfo": { + "base": "

Sidewalk-related information for devices in an import task that are being onboarded.

", + "refs": { + "GetWirelessDeviceImportTaskResponse$Sidewalk": "

The Sidewalk-related information about an import task.

", + "WirelessDeviceImportTask$Sidewalk": "

The Sidewalk-related information of the wireless device import task.

" + } + }, "SidewalkId": { "base": "

The sidewalk device identification.

", "refs": { @@ -3070,8 +3351,10 @@ "SidewalkManufacturingSn": { "base": null, "refs": { + "ImportedSidewalkDevice$SidewalkManufacturingSn": "

The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.

", "SidewalkDevice$SidewalkManufacturingSn": "

The Sidewalk manufacturing series number.

", - "SidewalkListDevice$SidewalkManufacturingSn": "

The Sidewalk manufacturing series number.

" + "SidewalkListDevice$SidewalkManufacturingSn": "

The Sidewalk manufacturing series number.

", + "SidewalkSingleStartImportInfo$SidewalkManufacturingSn": "

The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.

" } }, "SidewalkResourceTypeEventConfiguration": { @@ -3088,12 +3371,30 @@ "WirelessMetadata$Sidewalk": "

The Sidewalk account credentials.

" } }, + "SidewalkSingleStartImportInfo": { + "base": "

Information about an import task created for an individual Sidewalk device.

", + "refs": { + "StartSingleWirelessDeviceImportTaskRequest$Sidewalk": "

The Sidewalk-related parameters for importing a single wireless device.

" + } + }, + "SidewalkStartImportInfo": { + "base": "

Information about an import task created for bulk provisioning.

", + "refs": { + "StartWirelessDeviceImportTaskRequest$Sidewalk": "

The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

" + } + }, "SidewalkUpdateAccount": { "base": "

Sidewalk update.

", "refs": { "UpdatePartnerAccountRequest$Sidewalk": "

The Sidewalk account credentials.

" } }, + "SidewalkUpdateImportInfo": { + "base": "

Sidewalk object information for updating an import task.

", + "refs": { + "UpdateWirelessDeviceImportTaskRequest$Sidewalk": "

The Sidewalk-related parameters of the import task to be updated.

" + } + }, "SigningAlg": { "base": "

The certificate chain algorithm provided by sidewalk.

", "refs": { @@ -3140,6 +3441,16 @@ "refs": { } }, + "StartSingleWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "StartSingleWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "StartTime": { "base": "

Start time of a FUOTA task.

", "refs": { @@ -3147,12 +3458,29 @@ "LoRaWANStartFuotaTask$StartTime": null } }, + "StartWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "StartWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "Station": { "base": null, "refs": { "LoRaWANGatewayVersion$Station": "

The basic station version of the wireless gateway.

" } }, + "StatusReason": { + "base": null, + "refs": { + "GetWirelessDeviceImportTaskResponse$StatusReason": "

The reason for the provided status information, such as a validation error that causes the import task to fail.

", + "WirelessDeviceImportTask$StatusReason": "

The reason that provides additional information about the import task status.

" + } + }, "SubBand": { "base": "

A subset of supported frequency channels in a certain RFRegion.

", "refs": { @@ -3244,6 +3572,8 @@ "ListTagsForResourceResponse$Tags": "

The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

", "StartBulkAssociateWirelessDeviceWithMulticastGroupRequest$Tags": null, "StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest$Tags": null, + "StartSingleWirelessDeviceImportTaskRequest$Tags": null, + "StartWirelessDeviceImportTaskRequest$Tags": null, "TagResourceRequest$Tags": "

Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.

" } }, @@ -3535,6 +3865,16 @@ "LoRaWANUpdateGatewayTaskCreate$UpdateSignature": "

The signature used to verify the update firmware.

" } }, + "UpdateWirelessDeviceImportTaskRequest": { + "base": null, + "refs": { + } + }, + "UpdateWirelessDeviceImportTaskResponse": { + "base": null, + "refs": { + } + }, "UpdateWirelessDeviceRequest": { "base": null, "refs": { @@ -3698,6 +4038,18 @@ "GetWirelessDeviceRequest$IdentifierType": "

The type of identifier used in identifier.

" } }, + "WirelessDeviceImportTask": { + "base": "

Information about an import task for wireless devices.

", + "refs": { + "WirelessDeviceImportTaskList$member": null + } + }, + "WirelessDeviceImportTaskList": { + "base": null, + "refs": { + "ListWirelessDeviceImportTasksResponse$WirelessDeviceImportTaskList": "

List of import tasks and summary information of onboarding status of devices in each import task.

" + } + }, "WirelessDeviceList": { "base": null, "refs": { @@ -3729,6 +4081,13 @@ "WirelessDeviceStatistics$Name": "

The name of the resource.

" } }, + "WirelessDeviceSidewalkStatus": { + "base": null, + "refs": { + "SidewalkDevice$Status": "

The Sidewalk device status, such as provisioned or registered.

", + "SidewalkListDevice$Status": "

The status of the Sidewalk devices, such as provisioned or registered.

" + } + }, "WirelessDeviceStatistics": { "base": "

Information about a wireless device's operation.

", "refs": { @@ -3746,6 +4105,7 @@ "refs": { "CreateWirelessDeviceRequest$Type": "

The wireless device type.

", "DeleteQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, which can be either Sidewalk or LoRaWAN.

", + "DeregisterWirelessDeviceRequest$WirelessDeviceType": "

The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.

", "GetWirelessDeviceResponse$Type": "

The wireless device type.

", "ListQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, whic can be either Sidewalk or LoRaWAN.

", "ListWirelessDevicesRequest$WirelessDeviceType": "

A filter to list only the wireless devices that use this wireless device type.

", diff --git a/models/apis/iotwireless/2020-11-22/endpoint-rule-set-1.json b/models/apis/iotwireless/2020-11-22/endpoint-rule-set-1.json index 9757dfa55d6..013293bc815 100644 --- a/models/apis/iotwireless/2020-11-22/endpoint-rule-set-1.json +++ b/models/apis/iotwireless/2020-11-22/endpoint-rule-set-1.json @@ -324,101 +324,6 @@ "conditions": [], "type": "tree", "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "ap-northeast-1" - ] - } - ], - "endpoint": { - "url": "https://api.iotwireless.ap-northeast-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "ap-southeast-2" - ] - } - ], - "endpoint": { - "url": "https://api.iotwireless.ap-southeast-2.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "eu-west-1" - ] - } - ], - "endpoint": { - "url": "https://api.iotwireless.eu-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-east-1" - ] - } - ], - "endpoint": { - "url": "https://api.iotwireless.us-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-west-2" - ] - } - ], - "endpoint": { - "url": "https://api.iotwireless.us-west-2.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, { "conditions": [], "endpoint": { diff --git a/models/apis/iotwireless/2020-11-22/endpoint-tests-1.json b/models/apis/iotwireless/2020-11-22/endpoint-tests-1.json index 14f10f81866..a84cdd7cfdc 100644 --- a/models/apis/iotwireless/2020-11-22/endpoint-tests-1.json +++ b/models/apis/iotwireless/2020-11-22/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -21,9 +21,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -34,9 +34,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -47,9 +47,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -60,9 +60,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -73,9 +73,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -86,9 +86,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -99,9 +99,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -112,9 +112,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -125,9 +125,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -138,9 +138,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -151,9 +151,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -164,9 +164,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -177,9 +177,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -190,9 +190,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -203,9 +203,20 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -216,9 +227,20 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -229,9 +251,20 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -242,9 +275,20 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -255,9 +299,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-isob-east-1" } }, { @@ -268,9 +312,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -282,8 +326,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -293,9 +337,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -305,11 +349,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/medialive/2017-10-14/api-2.json b/models/apis/medialive/2017-10-14/api-2.json index acb486159d5..08fa764a5d2 100644 --- a/models/apis/medialive/2017-10-14/api-2.json +++ b/models/apis/medialive/2017-10-14/api-2.json @@ -4946,6 +4946,10 @@ "UhdDeviceSettings": { "shape": "InputDeviceUhdSettings", "locationName": "uhdDeviceSettings" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags" } } }, @@ -7399,11 +7403,12 @@ "Tag": { "shape": "__string", "locationName": "tag" + }, + "Id3": { + "shape": "__string", + "locationName": "id3" } - }, - "required": [ - "Tag" - ] + } }, "HlsId3SegmentTaggingState": { "type": "string", @@ -7946,6 +7951,10 @@ "UhdDeviceSettings": { "shape": "InputDeviceUhdSettings", "locationName": "uhdDeviceSettings" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags" } } }, @@ -8156,6 +8165,10 @@ "UhdDeviceSettings": { "shape": "InputDeviceUhdSettings", "locationName": "uhdDeviceSettings" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags" } } }, @@ -12912,6 +12925,10 @@ "UhdDeviceSettings": { "shape": "InputDeviceUhdSettings", "locationName": "uhdDeviceSettings" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags" } } }, diff --git a/models/apis/medialive/2017-10-14/docs-2.json b/models/apis/medialive/2017-10-14/docs-2.json index 277ffe381f8..6e9e23f7e21 100644 --- a/models/apis/medialive/2017-10-14/docs-2.json +++ b/models/apis/medialive/2017-10-14/docs-2.json @@ -4521,6 +4521,7 @@ "HlsGroupSettings$BaseUrlManifest1": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.", "HlsGroupSettings$KeyFormat": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given.", "HlsGroupSettings$KeyFormatVersions": "Either a single positive integer version value or a slash delimited list of version values (1/2/3).", + "HlsId3SegmentTaggingScheduleActionSettings$Id3": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", "HlsId3SegmentTaggingScheduleActionSettings$Tag": "ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html", "HlsOutputSettings$SegmentModifier": "String concatenated to end of segment filenames.", "HlsTimedMetadataScheduleActionSettings$Id3": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure", diff --git a/models/apis/medialive/2017-10-14/endpoint-tests-1.json b/models/apis/medialive/2017-10-14/endpoint-tests-1.json index 510effaf9d7..00763c67479 100644 --- a/models/apis/medialive/2017-10-14/endpoint-tests-1.json +++ b/models/apis/medialive/2017-10-14/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -21,9 +21,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -34,9 +34,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-south-1" + "UseFIPS": false } }, { @@ -47,9 +47,9 @@ } }, "params": { + "Region": "ap-southeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { @@ -60,9 +60,9 @@ } }, "params": { + "Region": "ap-southeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { @@ -73,9 +73,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false } }, { @@ -86,9 +86,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-north-1" + "UseFIPS": false } }, { @@ -99,9 +99,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-1" + "UseFIPS": false } }, { @@ -112,9 +112,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -125,9 +125,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" + "UseFIPS": false } }, { @@ -138,9 +138,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "sa-east-1" + "UseFIPS": false } }, { @@ -151,9 +151,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -164,9 +164,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -177,9 +177,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" + "UseFIPS": false } }, { @@ -190,9 +190,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": true } }, { @@ -203,9 +203,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false } }, { @@ -216,9 +216,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" + "UseFIPS": true } }, { @@ -229,9 +229,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -242,9 +242,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -255,9 +255,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" + "UseFIPS": true } }, { @@ -268,9 +268,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" + "UseFIPS": true } }, { @@ -281,9 +281,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { @@ -294,9 +294,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { @@ -307,9 +307,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-east-1" + "UseFIPS": true } }, { @@ -320,9 +320,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-east-1" + "UseFIPS": true } }, { @@ -333,9 +333,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-east-1" + "UseFIPS": false } }, { @@ -346,9 +346,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-east-1" + "UseFIPS": false } }, { @@ -359,9 +359,20 @@ } }, "params": { + "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": true } }, { @@ -372,9 +383,31 @@ } }, "params": { + "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": true } }, { @@ -385,9 +418,20 @@ } }, "params": { + "Region": "us-isob-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-isob-east-1" + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": false } }, { @@ -398,9 +442,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-isob-east-1" + "UseFIPS": false } }, { @@ -411,9 +455,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -436,9 +480,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -448,11 +492,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index d27ab4687e4..064baef213b 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -11,8 +11,8 @@ "CreateApp": "

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

", "CreateAppImageConfig": "

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

", "CreateArtifact": "

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "CreateAutoMLJob": "

Creates an Autopilot job.

Find the best-performing model after you run an Autopilot job by calling .

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

", - "CreateAutoMLJobV2": "

Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for Computer Vision or Natural Language Processing problems.

Find the resulting model after you run an AutoML job V2 by calling .

To create an AutoMLJob using tabular data, see .

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an error.

", + "CreateAutoMLJob": "

Creates an Autopilot job.

Find the best-performing model after you run an Autopilot job by calling DescribeAutoMLJob .

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

", + "CreateAutoMLJobV2": "

Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for Computer Vision or Natural Language Processing problems.

Find the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2 .

To create an AutoMLJob using tabular data, see CreateAutoMLJob .

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI or an SDK results in an error.

", "CreateCodeRepository": "

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

", "CreateCompilationJob": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", "CreateContext": "

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

", @@ -904,7 +904,7 @@ "AutoMLAlgorithmsConfig": { "base": null, "refs": { - "AutoMLCandidateGenerationConfig$AlgorithmsConfig": "

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

For the list of all algorithms per training mode, see .

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" + "AutoMLCandidateGenerationConfig$AlgorithmsConfig": "

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig .

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" } }, "AutoMLCandidate": { @@ -934,7 +934,7 @@ } }, "AutoMLChannel": { - "base": "

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see .

A validation dataset must contain the same headers as the training dataset.

", + "base": "

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel .

A validation dataset must contain the same headers as the training dataset.

", "refs": { "AutoMLInputDataConfig$member": null } @@ -947,7 +947,7 @@ } }, "AutoMLContainerDefinition": { - "base": "

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see .

", + "base": "

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition .

", "refs": { "AutoMLContainerDefinitions$member": null } @@ -993,7 +993,7 @@ "AutoMLInputDataConfig": { "base": null, "refs": { - "CreateAutoMLJobRequest$InputDataConfig": "

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

", + "CreateAutoMLJobRequest$InputDataConfig": "

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

", "DescribeAutoMLJobResponse$InputDataConfig": "

Returns the input data configuration for the AutoML job.

" } }, @@ -1021,7 +1021,7 @@ } }, "AutoMLJobChannel": { - "base": "

A channel is a named input source that training algorithms can consume. This channel is used for the non tabular training data of an AutoML job using the V2 API. For tabular training data, see . For more information, see .

", + "base": "

A channel is a named input source that training algorithms can consume. This channel is used for the non tabular training data of an AutoML job using the V2 API. For tabular training data, see AutoMLChannel . For more information, see Channel .

", "refs": { "AutoMLJobInputDataConfig$member": null } @@ -1045,7 +1045,7 @@ "AutoMLJobInputDataConfig": { "base": null, "refs": { - "CreateAutoMLJobV2Request$AutoMLJobInputDataConfig": "

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported formats depend on the problem type:

", + "CreateAutoMLJobV2Request$AutoMLJobInputDataConfig": "

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported formats depend on the problem type:

", "DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig": "

Returns an array of channel objects describing the input data and their location.

" } }, @@ -1066,8 +1066,8 @@ "AutoMLJobObjective": { "base": "

Specifies a metric to minimize or maximize as the objective of a job. V2 API jobs (for example jobs created by calling CreateAutoMLJobV2), support Accuracy only.

", "refs": { - "CreateAutoMLJobRequest$AutoMLJobObjective": "

Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it. For , only Accuracy is supported.

", - "CreateAutoMLJobV2Request$AutoMLJobObjective": "

Specifies a metric to minimize or maximize as the objective of a job. For , only Accuracy is supported.

", + "CreateAutoMLJobRequest$AutoMLJobObjective": "

Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it. For CreateAutoMLJobV2 , only Accuracy is supported.

", + "CreateAutoMLJobV2Request$AutoMLJobObjective": "

Specifies a metric to minimize or maximize as the objective of a job. For CreateAutoMLJobV2 , only Accuracy is supported.

", "DescribeAutoMLJobResponse$AutoMLJobObjective": "

Returns the job's objective.

", "DescribeAutoMLJobV2Response$AutoMLJobObjective": "

Returns the job's objective.

", "ResolvedAttributes$AutoMLJobObjective": null @@ -1125,7 +1125,7 @@ "base": null, "refs": { "AutoMLJobObjective$MetricName": "

The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.

Here are the options:

Accuracy

The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for both binary and multiclass classification. Accuracy measures how close the predicted class values are to the actual values. Values for accuracy metrics vary between zero (0) and one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect inaccuracy.

AUC

The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms that return probabilities, such as logistic regression. To map the probabilities into classifications, these are compared against a threshold value.

The relevant curve is the receiver operating characteristic curve (ROC curve). The ROC curve plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives, but more false negatives.

AUC is the area under this ROC curve. Therefore, AUC provides an aggregated measure of the model performance across all possible classification thresholds. AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a score of one half (0.5) indicates that the prediction is not better than a random classifier.

BalancedAccuracy

BalancedAccuracy is a metric that measures the ratio of accurate predictions to all predictions. This ratio is calculated after normalizing true positives (TP) and true negatives (TN) by the total number of positive (P) and negative (N) values. It is used in both binary and multiclass classification and is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1. BalancedAccuracy gives a better measure of accuracy when the number of positives or negatives differ greatly from each other in an imbalanced dataset. For example, when only 1% of email is spam.

F1

The F1 score is the harmonic mean of the precision and recall, defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class, and false when they do not.

Precision is the ratio of the true positive predictions to all positive predictions, and it includes the false positives in a dataset. Precision measures the quality of the prediction when it predicts the positive class.

Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances. Recall measures how completely a model predicts the actual class members in a dataset.

F1 scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.

F1macro

The F1macro score applies F1 scoring to multiclass classification problems. It does this by calculating the precision and recall, and then taking their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro averages the individual scores to obtain the F1macro score. F1macro scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.

MAE

The mean absolute error (MAE) is a measure of how different the predicted and actual values are, when they're averaged over all values. MAE is commonly used in regression analysis to understand model prediction error. If there is linear regression, MAE represents the average distance from a predicted line to the actual value. MAE is defined as the sum of absolute errors divided by the number of observations. Values range from 0 to infinity, with smaller numbers indicating a better model fit to the data.

MSE

The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive. The better a model is at predicting the actual values, the smaller the MSE value is

Precision

Precision measures how well an algorithm predicts the true positives (TP) out of all of the positives that it identifies. It is defined as follows: Precision = TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary classification. Precision is an important metric when the cost of a false positive is high. For example, the cost of a false positive is very high if an airplane safety system is falsely deemed safe to fly. A false positive (FP) reflects a positive prediction that is actually negative in the data.

PrecisionMacro

The precision macro computes precision for multiclass classification problems. It does this by calculating precision for each class and averaging scores to obtain precision for several classes. PrecisionMacro scores range from zero (0) to one (1). Higher scores reflect the model's ability to predict true positives (TP) out of all of the positives that it identifies, averaged across multiple classes.

R2

R2, also known as the coefficient of determination, is used in regression to quantify how much a model can explain the variance of a dependent variable. Values range from one (1) to negative one (-1). Higher numbers indicate a higher fraction of explained variability. R2 values close to zero (0) indicate that very little of the dependent variable can be explained by the model. Negative values indicate a poor fit and that the model is outperformed by a constant function. For linear regression, this is a horizontal line.

Recall

Recall measures how well an algorithm correctly predicts all of the true positives (TP) in a dataset. A true positive is a positive prediction that is also an actual positive value in the data. Recall is defined as follows: Recall = TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better ability of the model to predict true positives (TP) in the data, and is used in binary classification.

Recall is important when testing for cancer because it's used to find all of the true positives. A false positive (FP) reflects a positive prediction that is actually negative in the data. It is often insufficient to measure only recall, because predicting every output as a true positive yield a perfect recall score.

RecallMacro

The RecallMacro computes recall for multiclass classification problems by calculating recall for each class and averaging scores to obtain recall for several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the model's ability to predict true positives (TP) in a dataset. Whereas, a true positive reflects a positive prediction that is also an actual positive value in the data. It is often insufficient to measure only recall, because predicting every output as a true positive yields a perfect recall score.

RMSE

Root mean squared error (RMSE) measures the square root of the squared difference between predicted and actual values, and it's averaged over all values. It is used in regression analysis to understand model prediction error. It's an important metric to indicate the presence of large model errors and outliers. Values range from zero (0) to infinity, with smaller numbers indicating a better model fit to the data. RMSE is dependent on scale, and should not be used to compare datasets of different sizes.

If you do not specify a metric explicitly, the default behavior is to automatically use:

", - "FinalAutoMLJobObjectiveMetric$MetricName": "

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

", + "FinalAutoMLJobObjectiveMetric$MetricName": "

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName .

", "FinalAutoMLJobObjectiveMetric$StandardMetricName": "

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

", "MetricDatum$MetricName": "

The name of the metric.

" } @@ -2067,7 +2067,7 @@ "ContainerImage": { "base": null, "refs": { - "AutoMLContainerDefinition$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .

", + "AutoMLContainerDefinition$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition .

", "ContainerDefinition$Image": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

", "DeployedImage$SpecifiedImage": "

The image path you specified when you created the model.

", "DeployedImage$ResolvedImage": "

The specific digest path of the image hosted in this ProductionVariant.

", @@ -4843,7 +4843,7 @@ "EnvironmentMap": { "base": null, "refs": { - "AutoMLContainerDefinition$Environment": "

The environment variables to set in the container. For more information, see .

", + "AutoMLContainerDefinition$Environment": "

The environment variables to set in the container. For more information, see ContainerDefinition .

", "ContainerDefinition$Environment": "

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

", "ModelPackageContainerDefinition$Environment": "

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

" } @@ -5970,7 +5970,7 @@ "HyperParameterTrainingJobEnvironmentMap": { "base": null, "refs": { - "HyperParameterTrainingJobDefinition$Environment": "

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.

" + "HyperParameterTrainingJobDefinition$Environment": "

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.

" } }, "HyperParameterTrainingJobEnvironmentValue": { @@ -6181,7 +6181,7 @@ "HyperbandStrategyMaxResource": { "base": null, "refs": { - "HyperbandStrategyConfig$MaxResource": "

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributive training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

" + "HyperbandStrategyConfig$MaxResource": "

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters :

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributive training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

" } }, "HyperbandStrategyMinResource": { @@ -8163,7 +8163,7 @@ "MaxRuntimePerTrainingJobInSeconds": { "base": null, "refs": { - "AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds": "

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the used by the action.

For V2 jobs (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

" + "AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds": "

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For V2 jobs (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

" } }, "MaxWaitTimeInSeconds": { @@ -8250,7 +8250,7 @@ } }, "MetricDefinition": { - "base": "

Specifies a metric that the training algorithm writes to stderr or stdout. SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

", + "base": "

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

", "refs": { "MetricDefinitionList$member": null } @@ -8276,7 +8276,7 @@ "MetricRegex": { "base": null, "refs": { - "MetricDefinition$Regex": "

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

" + "MetricDefinition$Regex": "

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

" } }, "MetricSetSource": { @@ -10467,7 +10467,7 @@ "ProblemType": { "base": null, "refs": { - "CreateAutoMLJobRequest$ProblemType": "

Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.

", + "CreateAutoMLJobRequest$ProblemType": "

Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.

", "DescribeAutoMLJobResponse$ProblemType": "

Returns the job's problem type.

", "ResolvedAttributes$ProblemType": "

The problem type.

" } @@ -14367,7 +14367,7 @@ "Url": { "base": null, "refs": { - "AutoMLContainerDefinition$ModelDataUrl": "

The location of the model artifacts. For more information, see .

", + "AutoMLContainerDefinition$ModelDataUrl": "

The location of the model artifacts. For more information, see ContainerDefinition .

", "ClarifyShapBaselineConfig$ShapBaselineUri": "

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

", "ContainerDefinition$ModelDataUrl": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

", "ModelPackageContainerDefinition$ModelDataUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

", diff --git a/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json b/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json index 0abd6961c5d..38c8c0bf1ae 100644 --- a/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json +++ b/models/apis/sagemaker/2017-07-24/endpoint-tests-1.json @@ -8,8 +8,8 @@ } }, "params": { - "Region": "af-south-1", "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false } }, @@ -21,8 +21,8 @@ } }, "params": { - "Region": "ap-east-1", "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false } }, @@ -34,8 +34,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false } }, @@ -47,8 +47,8 @@ } }, "params": { - "Region": "ap-northeast-2", "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false } }, @@ -60,8 +60,8 @@ } }, "params": { - "Region": "ap-northeast-3", "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false } }, @@ -73,8 +73,8 @@ } }, "params": { - "Region": "ap-south-1", "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false } }, @@ -86,8 +86,8 @@ } }, "params": { - "Region": "ap-southeast-1", "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false } }, @@ -99,8 +99,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false } }, @@ -112,8 +112,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false } }, @@ -125,8 +125,8 @@ } }, "params": { - "Region": "eu-central-1", "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false } }, @@ -138,8 +138,8 @@ } }, "params": { - "Region": "eu-north-1", "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false } }, @@ -151,8 +151,8 @@ } }, "params": { - "Region": "eu-south-1", "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false } }, @@ -164,8 +164,8 @@ } }, "params": { - "Region": "eu-west-1", "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false } }, @@ -177,8 +177,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false } }, @@ -190,8 +190,8 @@ } }, "params": { - "Region": "eu-west-3", "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false } }, @@ -203,8 +203,8 @@ } }, "params": { - "Region": "me-south-1", "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false } }, @@ -216,8 +216,8 @@ } }, "params": { - "Region": "sa-east-1", "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false } }, @@ -229,8 +229,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false } }, @@ -242,8 +242,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true } }, @@ -255,8 +255,8 @@ } }, "params": { - "Region": "us-east-2", "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false } }, @@ -268,8 +268,8 @@ } }, "params": { - "Region": "us-east-2", "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": true } }, @@ -281,8 +281,8 @@ } }, "params": { - "Region": "us-west-1", "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false } }, @@ -294,8 +294,8 @@ } }, "params": { - "Region": "us-west-1", "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true } }, @@ -307,8 +307,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false } }, @@ -320,8 +320,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true } }, @@ -333,8 +333,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true } }, @@ -346,8 +346,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false } }, @@ -359,8 +359,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -372,8 +372,8 @@ } }, "params": { - "Region": "cn-northwest-1", "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false } }, @@ -385,8 +385,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -398,8 +398,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -411,8 +411,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -424,8 +424,8 @@ } }, "params": { - "Region": "us-gov-west-1", "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false } }, @@ -437,8 +437,8 @@ } }, "params": { - "Region": "us-gov-west-1", "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true } }, @@ -450,8 +450,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -463,8 +463,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -476,8 +476,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false } }, @@ -489,8 +489,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false } }, @@ -502,8 +502,8 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false } }, @@ -513,8 +513,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true } }, @@ -526,8 +526,8 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true } }, @@ -537,8 +537,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": false } }, @@ -548,8 +548,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": true } }, @@ -561,8 +561,8 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true } }, @@ -572,8 +572,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false } }, @@ -585,8 +585,8 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false } }, @@ -598,8 +598,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -623,8 +623,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, "Endpoint": "https://example.com" } @@ -635,8 +635,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } diff --git a/models/apis/securityhub/2018-10-26/api-2.json b/models/apis/securityhub/2018-10-26/api-2.json index c11b7d91feb..26bda2089a8 100644 --- a/models/apis/securityhub/2018-10-26/api-2.json +++ b/models/apis/securityhub/2018-10-26/api-2.json @@ -1126,6 +1126,28 @@ "type":"list", "member":{"shape":"AssociatedStandard"} }, + "AssociationSetDetails":{ + "type":"structure", + "members":{ + "AssociationState":{"shape":"AssociationStateDetails"}, + "GatewayId":{"shape":"NonEmptyString"}, + "Main":{"shape":"Boolean"}, + "RouteTableAssociationId":{"shape":"NonEmptyString"}, + "RouteTableId":{"shape":"NonEmptyString"}, + "SubnetId":{"shape":"NonEmptyString"} + } + }, + "AssociationSetList":{ + "type":"list", + "member":{"shape":"AssociationSetDetails"} + }, + "AssociationStateDetails":{ + "type":"structure", + "members":{ + "State":{"shape":"NonEmptyString"}, + "StatusMessage":{"shape":"NonEmptyString"} + } + }, "AssociationStatus":{ "type":"string", "enum":[ @@ -2177,7 +2199,8 @@ "LaunchedAt":{"shape":"NonEmptyString"}, "NetworkInterfaces":{"shape":"AwsEc2InstanceNetworkInterfacesList"}, "VirtualizationType":{"shape":"NonEmptyString"}, - "MetadataOptions":{"shape":"AwsEc2InstanceMetadataOptions"} + "MetadataOptions":{"shape":"AwsEc2InstanceMetadataOptions"}, + "Monitoring":{"shape":"AwsEc2InstanceMonitoringDetails"} } }, "AwsEc2InstanceMetadataOptions":{ @@ -2190,6 +2213,12 @@ "InstanceMetadataTags":{"shape":"NonEmptyString"} } }, + "AwsEc2InstanceMonitoringDetails":{ + "type":"structure", + "members":{ + "State":{"shape":"NonEmptyString"} + } + }, "AwsEc2InstanceNetworkInterfacesDetails":{ "type":"structure", "members":{ @@ -2656,6 +2685,17 @@ "type":"list", "member":{"shape":"AwsEc2NetworkInterfaceSecurityGroup"} }, + "AwsEc2RouteTableDetails":{ + "type":"structure", + "members":{ + "AssociationSet":{"shape":"AssociationSetList"}, + "OwnerId":{"shape":"NonEmptyString"}, + "PropagatingVgwSet":{"shape":"PropagatingVgwSetList"}, + "RouteTableId":{"shape":"NonEmptyString"}, + "RouteSet":{"shape":"RouteSetList"}, + "VpcId":{"shape":"NonEmptyString"} + } + }, "AwsEc2SecurityGroupDetails":{ "type":"structure", "members":{ @@ -3625,7 +3665,8 @@ "type":"structure", "members":{ "SecurityGroupIds":{"shape":"NonEmptyStringList"}, - "SubnetIds":{"shape":"NonEmptyStringList"} + "SubnetIds":{"shape":"NonEmptyStringList"}, + "EndpointPublicAccess":{"shape":"Boolean"} } }, "AwsElasticBeanstalkEnvironmentDetails":{ @@ -5174,7 +5215,8 @@ "BucketLoggingConfiguration":{"shape":"AwsS3BucketLoggingConfiguration"}, "BucketWebsiteConfiguration":{"shape":"AwsS3BucketWebsiteConfiguration"}, "BucketNotificationConfiguration":{"shape":"AwsS3BucketNotificationConfiguration"}, - "BucketVersioningConfiguration":{"shape":"AwsS3BucketBucketVersioningConfiguration"} + "BucketVersioningConfiguration":{"shape":"AwsS3BucketBucketVersioningConfiguration"}, + "ObjectLockConfiguration":{"shape":"AwsS3BucketObjectLockConfiguration"} } }, "AwsS3BucketLoggingConfiguration":{ @@ -5237,6 +5279,27 @@ "type":"list", "member":{"shape":"AwsS3BucketNotificationConfigurationS3KeyFilterRule"} }, + "AwsS3BucketObjectLockConfiguration":{ + "type":"structure", + "members":{ + "ObjectLockEnabled":{"shape":"NonEmptyString"}, + "Rule":{"shape":"AwsS3BucketObjectLockConfigurationRuleDetails"} + } + }, + "AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails":{ + "type":"structure", + "members":{ + "Days":{"shape":"Integer"}, + "Mode":{"shape":"NonEmptyString"}, + "Years":{"shape":"Integer"} + } + }, + "AwsS3BucketObjectLockConfigurationRuleDetails":{ + "type":"structure", + "members":{ + "DefaultRetention":{"shape":"AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails"} + } + }, "AwsS3BucketServerSideEncryptionByDefault":{ "type":"structure", "members":{ @@ -7624,6 +7687,16 @@ "type":"list", "member":{"shape":"Product"} }, + "PropagatingVgwSetDetails":{ + "type":"structure", + "members":{ + "GatewayId":{"shape":"NonEmptyString"} + } + }, + "PropagatingVgwSetList":{ + "type":"list", + "member":{"shape":"PropagatingVgwSetDetails"} + }, "Range":{ "type":"structure", "members":{ @@ -7813,7 +7886,8 @@ "AwsEc2LaunchTemplate":{"shape":"AwsEc2LaunchTemplateDetails"}, "AwsSageMakerNotebookInstance":{"shape":"AwsSageMakerNotebookInstanceDetails"}, "AwsWafv2WebAcl":{"shape":"AwsWafv2WebAclDetails"}, - "AwsWafv2RuleGroup":{"shape":"AwsWafv2RuleGroupDetails"} + "AwsWafv2RuleGroup":{"shape":"AwsWafv2RuleGroupDetails"}, + "AwsEc2RouteTable":{"shape":"AwsEc2RouteTableDetails"} } }, "ResourceList":{ @@ -7840,6 +7914,31 @@ "type":"list", "member":{"shape":"Result"} }, + "RouteSetDetails":{ + "type":"structure", + "members":{ + "CarrierGatewayId":{"shape":"NonEmptyString"}, + "CoreNetworkArn":{"shape":"NonEmptyString"}, + "DestinationCidrBlock":{"shape":"NonEmptyString"}, + "DestinationIpv6CidrBlock":{"shape":"NonEmptyString"}, + "DestinationPrefixListId":{"shape":"NonEmptyString"}, + "EgressOnlyInternetGatewayId":{"shape":"NonEmptyString"}, + "GatewayId":{"shape":"NonEmptyString"}, + "InstanceId":{"shape":"NonEmptyString"}, + "InstanceOwnerId":{"shape":"NonEmptyString"}, + "LocalGatewayId":{"shape":"NonEmptyString"}, + "NatGatewayId":{"shape":"NonEmptyString"}, + "NetworkInterfaceId":{"shape":"NonEmptyString"}, + "Origin":{"shape":"NonEmptyString"}, + "State":{"shape":"NonEmptyString"}, + "TransitGatewayId":{"shape":"NonEmptyString"}, + "VpcPeeringConnectionId":{"shape":"NonEmptyString"} + } + }, + "RouteSetList":{ + "type":"list", + "member":{"shape":"RouteSetDetails"} + }, "RuleGroupDetails":{ "type":"structure", "members":{ diff --git a/models/apis/securityhub/2018-10-26/docs-2.json b/models/apis/securityhub/2018-10-26/docs-2.json index e45127ff123..ad5b7c8f16d 100644 --- a/models/apis/securityhub/2018-10-26/docs-2.json +++ b/models/apis/securityhub/2018-10-26/docs-2.json @@ -15,11 +15,11 @@ "CreateFindingAggregator": "

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.

", "CreateInsight": "

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

", "CreateMembers": "

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", - "DeclineInvitations": "

Declines invitations to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

", + "DeclineInvitations": "

Declines invitations to become a member account.

A prospective member account uses this operation to decline an invitation to become a member.

This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.

", "DeleteActionTarget": "

Deletes a custom action target from Security Hub.

Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

", "DeleteFindingAggregator": "

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.

", "DeleteInsight": "

Deletes the insight specified by the InsightArn.

", - "DeleteInvitations": "

Deletes invitations received by the Amazon Web Services account to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

", + "DeleteInvitations": "

Deletes invitations received by the Amazon Web Services account to become a member account.

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.

", "DeleteMembers": "

Deletes the specified member accounts from Security Hub.

Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.

", "DescribeActionTargets": "

Returns a list of the custom action targets in Security Hub in your account.

", "DescribeHub": "

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

", @@ -114,8 +114,8 @@ "AccountIdList": { "base": null, "refs": { - "DeclineInvitationsRequest$AccountIds": "

The list of account IDs for the accounts from which to decline the invitations to Security Hub.

", - "DeleteInvitationsRequest$AccountIds": "

The list of the account IDs that sent the invitations to delete.

", + "DeclineInvitationsRequest$AccountIds": "

The list of prospective member account IDs for which to decline an invitation.

", + "DeleteInvitationsRequest$AccountIds": "

The list of member account IDs that received the invitations you want to delete.

", "DeleteMembersRequest$AccountIds": "

The list of account IDs for the member accounts to delete.

", "DisassociateMembersRequest$AccountIds": "

The account IDs of the member accounts to disassociate from the administrator account.

", "GetMembersRequest$AccountIds": "

The list of account IDs for the Security Hub member accounts to return the details for.

", @@ -222,6 +222,24 @@ "Compliance$AssociatedStandards": "

The enabled security standards in which a security control is currently enabled.

" } }, + "AssociationSetDetails": { + "base": "

The associations between a route table and one or more subnets or a gateway.

", + "refs": { + "AssociationSetList$member": null + } + }, + "AssociationSetList": { + "base": null, + "refs": { + "AwsEc2RouteTableDetails$AssociationSet": "

The associations between a route table and one or more subnets or a gateway.

" + } + }, + "AssociationStateDetails": { + "base": "

Describes the state of an association between a route table and a subnet or gateway.

", + "refs": { + "AssociationSetDetails$AssociationState": "

The state of the association between a route table and a subnet or gateway.

" + } + }, "AssociationStatus": { "base": null, "refs": { @@ -955,6 +973,12 @@ "AwsEc2InstanceDetails$MetadataOptions": "

Details about the metadata options for the Amazon EC2 instance.

" } }, + "AwsEc2InstanceMonitoringDetails": { + "base": "

The type of monitoring that’s turned on for an Amazon EC2 instance.

", + "refs": { + "AwsEc2InstanceDetails$Monitoring": "

Describes the type of monitoring that’s turned on for an instance.

" + } + }, "AwsEc2InstanceNetworkInterfacesDetails": { "base": "

Identifies a network interface for the Amazon EC2 instance.

", "refs": { @@ -1309,6 +1333,12 @@ "AwsEc2NetworkInterfaceDetails$SecurityGroups": "

Security groups for the network interface.

" } }, + "AwsEc2RouteTableDetails": { + "base": "

Provides details about a route table for the specified VPC.

", + "refs": { + "ResourceDetails$AwsEc2RouteTable": "

Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.

" + } + }, "AwsEc2SecurityGroupDetails": { "base": "

Details about an Amazon EC2 security group.

", "refs": { @@ -3186,6 +3216,24 @@ "AwsS3BucketNotificationConfigurationS3KeyFilter$FilterRules": "

The filter rules for the filter.

" } }, + "AwsS3BucketObjectLockConfiguration": { + "base": "

The container element for S3 Object Lock configuration parameters. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.

", + "refs": { + "AwsS3BucketDetails$ObjectLockConfiguration": "

Specifies which rule Amazon S3 applies by default to every new object placed in the specified bucket.

" + } + }, + "AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails": { + "base": "

The default S3 Object Lock retention mode and period that you want to apply to new objects placed in the specified Amazon S3 bucket.

", + "refs": { + "AwsS3BucketObjectLockConfigurationRuleDetails$DefaultRetention": "

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket.

" + } + }, + "AwsS3BucketObjectLockConfigurationRuleDetails": { + "base": "

Specifies the S3 Object Lock rule for the specified object. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.

", + "refs": { + "AwsS3BucketObjectLockConfiguration$Rule": "

Specifies the Object Lock rule for the specified object.

" + } + }, "AwsS3BucketServerSideEncryptionByDefault": { "base": "

Specifies the default server-side encryption to apply to new objects in the bucket.

", "refs": { @@ -3730,6 +3778,7 @@ "Boolean": { "base": null, "refs": { + "AssociationSetDetails$Main": "

Indicates whether this is the main route table.

", "AwsApiGatewayCanarySettings$UseStageCache": "

Indicates whether the canary deployment uses the stage cache.

", "AwsApiGatewayMethodSettings$MetricsEnabled": "

Indicates whether CloudWatch metrics are enabled for the method.

", "AwsApiGatewayMethodSettings$DataTraceEnabled": "

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

", @@ -3817,6 +3866,7 @@ "AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails$ReadOnly": "

Whether the container has read-only access to the volume.

", "AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails$Autoprovision": "

Whether to create the Docker volume automatically if it does not already exist.

", "AwsEksClusterLoggingClusterLoggingDetails$Enabled": "

Whether the logging types that are listed in Types are enabled.

", + "AwsEksClusterResourcesVpcConfigDetails$EndpointPublicAccess": "

Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

", "AwsElasticsearchDomainDomainEndpointOptions$EnforceHTTPS": "

Whether to require that all traffic to the domain arrive over HTTPS.

", "AwsElasticsearchDomainElasticsearchClusterConfigDetails$DedicatedMasterEnabled": "

Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.

", "AwsElasticsearchDomainElasticsearchClusterConfigDetails$ZoneAwarenessEnabled": "

Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

", @@ -3996,8 +4046,8 @@ "ControlFindingGenerator": { "base": null, "refs": { - "DescribeHubResponse$ControlFindingGenerator": "

Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 9, 2023.

", - "EnableSecurityHubRequest$ControlFindingGenerator": "

This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 9, 2023.

", + "DescribeHubResponse$ControlFindingGenerator": "

Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 23, 2023.

", + "EnableSecurityHubRequest$ControlFindingGenerator": "

This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 23, 2023.

", "UpdateSecurityHubConfigurationRequest$ControlFindingGenerator": "

Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.

For accounts that are part of an organization, this value can only be updated in the administrator account.

" } }, @@ -4790,6 +4840,8 @@ "AwsS3BucketBucketLifecycleConfigurationRulesDetails$NoncurrentVersionExpirationInDays": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

", "AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails$Days": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

", "AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails$Days": "

The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.

", + "AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails$Days": "

The number of days that you want to specify for the default retention period.

", + "AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails$Years": "

The number of years that you want to specify for the default retention period.

", "AwsSageMakerNotebookInstanceDetails$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance.

", "AwsSecretsManagerSecretRotationRules$AutomaticallyAfterDays": "

The number of days after the previous rotation to rotate the secret.

", "AwsSecurityFinding$Confidence": "

A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

", @@ -4836,7 +4888,7 @@ "PortRangeFromTo$From": "

The first port in the port range.

", "PortRangeFromTo$To": "

The last port in the port range.

", "ProcessDetails$Pid": "

The process ID.

", - "ProcessDetails$ParentPid": "

The parent process ID.

", + "ProcessDetails$ParentPid": "

The parent process ID. This field accepts positive integers between O and 2147483647.

", "RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts$FromPort": "

The starting port value for the port range.

", "RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts$ToPort": "

The ending port value for the port range.

", "RuleGroupSourceStatelessRuleMatchAttributesProtocolsList$member": null, @@ -5253,6 +5305,12 @@ "AdminAccount$AccountId": "

The Amazon Web Services account identifier of the Security Hub administrator account.

", "ArnList$member": null, "AssociatedStandard$StandardsId": "

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

", + "AssociationSetDetails$GatewayId": "

The ID of the internet gateway or virtual private gateway.

", + "AssociationSetDetails$RouteTableAssociationId": "

The ID of the association.

", + "AssociationSetDetails$RouteTableId": "

The ID of the route table.

", + "AssociationSetDetails$SubnetId": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "AssociationStateDetails$State": "

The state of the association.

", + "AssociationStateDetails$StatusMessage": "

The status message, if applicable.

", "AvailabilityZone$ZoneName": "

The name of the Availability Zone.

", "AvailabilityZone$SubnetId": "

The ID of the subnet. You can specify one subnet per Availability Zone.

", "AwsApiCallAction$Api": "

The name of the API method that was issued.

", @@ -5539,6 +5597,7 @@ "AwsEc2InstanceMetadataOptions$HttpProtocolIpv6": "

Enables or disables the IPv6 endpoint for the instance metadata service.

", "AwsEc2InstanceMetadataOptions$HttpTokens": "

The state of token usage for your instance metadata requests.

", "AwsEc2InstanceMetadataOptions$InstanceMetadataTags": "

Specifies whether to allow access to instance tags from the instance metadata.

", + "AwsEc2InstanceMonitoringDetails$State": "

Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.

", "AwsEc2InstanceNetworkInterfacesDetails$NetworkInterfaceId": "

The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.

", "AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails$DeviceName": "

The device name.

", "AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails$NoDevice": "

Omits the device from the block device mapping when an empty string is specified.

", @@ -5617,6 +5676,9 @@ "AwsEc2NetworkInterfacePrivateIpAddressDetail$PrivateDnsName": "

The private DNS name for the IP address.

", "AwsEc2NetworkInterfaceSecurityGroup$GroupName": "

The name of the security group.

", "AwsEc2NetworkInterfaceSecurityGroup$GroupId": "

The ID of the security group.

", + "AwsEc2RouteTableDetails$OwnerId": "

The ID of the Amazon Web Services account that owns the route table.

", + "AwsEc2RouteTableDetails$RouteTableId": "

The ID of the route table.

", + "AwsEc2RouteTableDetails$VpcId": "

The ID of the virtual private cloud (VPC).

", "AwsEc2SecurityGroupDetails$GroupName": "

The name of the security group.

", "AwsEc2SecurityGroupDetails$GroupId": "

The ID of the security group.

", "AwsEc2SecurityGroupDetails$OwnerId": "

The Amazon Web Services account ID of the owner of the security group.

", @@ -6237,6 +6299,8 @@ "AwsS3BucketNotificationConfigurationDetail$Type": "

Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows:

", "AwsS3BucketNotificationConfigurationEvents$member": null, "AwsS3BucketNotificationConfigurationS3KeyFilterRule$Value": "

The filter value.

", + "AwsS3BucketObjectLockConfiguration$ObjectLockEnabled": "

Indicates whether the bucket has an Object Lock configuration enabled.

", + "AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails$Mode": "

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

", "AwsS3BucketServerSideEncryptionByDefault$SSEAlgorithm": "

Server-side encryption algorithm to use for the default encryption. Valid values are aws: kms or AES256.

", "AwsS3BucketServerSideEncryptionByDefault$KMSMasterKeyID": "

KMS key ID to use for the default encryption.

", "AwsS3BucketWebsiteConfiguration$ErrorDocument": "

The name of the error document for the website.

", @@ -6528,6 +6592,7 @@ "Product$ActivationUrl": "

The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

", "Product$ProductSubscriptionResourcePolicy": "

The resource policy associated with the product.

", "ProductSubscriptionArnList$member": null, + "PropagatingVgwSetDetails$GatewayId": "

The ID of the virtual private gateway.

", "Recommendation$Text": "

Describes the recommended steps to take to remediate an issue identified in a finding.

", "Recommendation$Url": "

A URL to a page or site that contains information about how to remediate a finding.

", "Record$JsonPath": "

The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.

", @@ -6543,6 +6608,22 @@ "ResourceNotFoundException$Message": null, "ResourceNotFoundException$Code": null, "Result$ProcessingResult": "

The reason that the account was not processed.

", + "RouteSetDetails$CarrierGatewayId": "

The ID of the carrier gateway.

", + "RouteSetDetails$CoreNetworkArn": "

The Amazon Resource Name (ARN) of the core network.

", + "RouteSetDetails$DestinationCidrBlock": "

The IPv4 CIDR block used for the destination match.

", + "RouteSetDetails$DestinationIpv6CidrBlock": "

The IPv6 CIDR block used for the destination match.

", + "RouteSetDetails$DestinationPrefixListId": "

The prefix of the destination Amazon Web Service.

", + "RouteSetDetails$EgressOnlyInternetGatewayId": "

The ID of the egress-only internet gateway.

", + "RouteSetDetails$GatewayId": "

The ID of a gateway attached to your VPC.

", + "RouteSetDetails$InstanceId": "

The ID of a NAT instance in your VPC.

", + "RouteSetDetails$InstanceOwnerId": "

The ID of the Amazon Web Services account that owns the instance.

", + "RouteSetDetails$LocalGatewayId": "

The ID of the local gateway.

", + "RouteSetDetails$NatGatewayId": "

The ID of a NAT gateway.

", + "RouteSetDetails$NetworkInterfaceId": "

The ID of the network interface.

", + "RouteSetDetails$Origin": "

Describes how the route was created.

", + "RouteSetDetails$State": "

The state of the route.

", + "RouteSetDetails$TransitGatewayId": "

The ID of a transit gateway.

", + "RouteSetDetails$VpcPeeringConnectionId": "

The ID of a VPC peering connection.

", "RuleGroupSource$RulesString": "

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

", "RuleGroupSourceCustomActionsDetails$ActionName": "

A descriptive name of the custom action.

", "RuleGroupSourceListDetails$GeneratedRulesType": "

Indicates whether to allow or deny access to the domains listed in Targets.

", @@ -6775,7 +6856,7 @@ "AwsSecurityFindingFilters$NetworkSourcePort": "

The source port of network-related information about a finding.

", "AwsSecurityFindingFilters$NetworkDestinationPort": "

The destination port of network-related information about a finding.

", "AwsSecurityFindingFilters$ProcessPid": "

The process ID.

", - "AwsSecurityFindingFilters$ProcessParentPid": "

The parent process ID.

", + "AwsSecurityFindingFilters$ProcessParentPid": "

The parent process ID. This field accepts positive integers between O and 2147483647.

", "AwsSecurityFindingFilters$FindingProviderFieldsConfidence": "

The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

", "AwsSecurityFindingFilters$FindingProviderFieldsCriticality": "

The finding provider value for the level of importance assigned to the resources associated with the findings.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

" } @@ -6872,6 +6953,18 @@ "DescribeProductsResponse$Products": "

A list of products, including details for each product.

" } }, + "PropagatingVgwSetDetails": { + "base": "

Describes a virtual private gateway propagating route.

", + "refs": { + "PropagatingVgwSetList$member": null + } + }, + "PropagatingVgwSetList": { + "base": null, + "refs": { + "AwsEc2RouteTableDetails$PropagatingVgwSet": "

Describes a virtual private gateway propagating route.

" + } + }, "Range": { "base": "

Identifies where the sensitive data begins and ends.

", "refs": { @@ -7010,6 +7103,18 @@ "InviteMembersResponse$UnprocessedAccounts": "

The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.

" } }, + "RouteSetDetails": { + "base": "

Provides details about the routes in the route table.

", + "refs": { + "RouteSetList$member": null + } + }, + "RouteSetList": { + "base": null, + "refs": { + "AwsEc2RouteTableDetails$RouteSet": "

The routes in the route table.

" + } + }, "RuleGroupDetails": { "base": "

Details about the rule group.

", "refs": { diff --git a/models/apis/securityhub/2018-10-26/endpoint-tests-1.json b/models/apis/securityhub/2018-10-26/endpoint-tests-1.json index 65eb0973fbe..ff107f7ff4f 100644 --- a/models/apis/securityhub/2018-10-26/endpoint-tests-1.json +++ b/models/apis/securityhub/2018-10-26/endpoint-tests-1.json @@ -8,8 +8,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -21,8 +21,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -34,8 +34,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -47,8 +47,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -60,8 +60,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -73,8 +73,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -86,8 +86,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -99,8 +99,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -112,8 +112,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -125,8 +125,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -138,8 +138,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -151,8 +151,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -164,8 +164,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -177,8 +177,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -190,8 +190,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -203,8 +203,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -216,8 +216,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -229,8 +229,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -242,8 +242,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -255,8 +255,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -268,8 +268,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -281,8 +281,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -294,8 +294,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -307,8 +307,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -320,8 +320,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -333,8 +333,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -346,8 +346,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -359,8 +359,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -372,8 +372,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -385,8 +385,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -398,8 +398,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -411,8 +411,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -424,8 +424,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -437,8 +437,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -450,8 +450,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -463,8 +463,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -476,8 +476,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -489,8 +489,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -502,8 +502,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -515,8 +515,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -528,8 +528,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -541,8 +541,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -554,8 +554,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -567,8 +567,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -581,8 +581,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -592,8 +592,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -604,8 +604,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json index 15261f6810c..91df3320d00 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json @@ -42,7 +42,8 @@ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} ] }, "CreateApplication":{ @@ -58,7 +59,8 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} ] }, "CreateAttributeGroup":{ @@ -130,7 +132,8 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} ] }, "GetApplication":{ @@ -300,7 +303,9 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} ] }, "TagResource":{ @@ -343,7 +348,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ] }, "UpdateAttributeGroup":{ @@ -395,7 +401,7 @@ "type":"string", "max":256, "min":1, - "pattern":"[-.\\w]+" + "pattern":"([-.\\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[-.\\w]+)" }, "ApplicationSummaries":{ "type":"list", @@ -494,7 +500,7 @@ }, "AttributeGroupArn":{ "type":"string", - "pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+" + "pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[-.\\w]+" }, "AttributeGroupDetails":{ "type":"structure", @@ -505,7 +511,8 @@ "shape":"Name", "deprecated":true, "deprecatedMessage":"This field is deprecated. We recommend not using the field when using ListAttributeGroupsForApplication." - } + }, + "createdBy":{"shape":"CreatedBy"} } }, "AttributeGroupDetailsList":{ @@ -514,9 +521,9 @@ }, "AttributeGroupId":{ "type":"string", - "max":26, - "min":26, - "pattern":"[a-z0-9]+" + "max":256, + "min":1, + "pattern":"[-.\\w]+" }, "AttributeGroupIds":{ "type":"list", @@ -524,9 +531,9 @@ }, "AttributeGroupSpecifier":{ "type":"string", - "max":256, + "max":512, "min":1, - "pattern":"[-.\\w]+" + "pattern":"([-.\\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[-.\\w]+)" }, "AttributeGroupSummaries":{ "type":"list", @@ -540,7 +547,8 @@ "name":{"shape":"Name"}, "description":{"shape":"Description"}, "creationTime":{"shape":"Timestamp"}, - "lastUpdateTime":{"shape":"Timestamp"} + "lastUpdateTime":{"shape":"Timestamp"}, + "createdBy":{"shape":"CreatedBy"} } }, "Attributes":{ @@ -609,6 +617,12 @@ "attributeGroup":{"shape":"AttributeGroup"} } }, + "CreatedBy":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!-)([a-z0-9-]+\\.)+(aws\\.internal|amazonaws\\.com(\\.cn)?)$" + }, "DeleteApplicationRequest":{ "type":"structure", "required":["application"], @@ -782,7 +796,8 @@ "attributes":{"shape":"Attributes"}, "creationTime":{"shape":"Timestamp"}, "lastUpdateTime":{"shape":"Timestamp"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "createdBy":{"shape":"CreatedBy"} } }, "GetConfigurationResponse":{ @@ -1157,6 +1172,16 @@ "max":50, "min":0 }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "serviceCode":{"shape":"String"} + }, + "error":{"httpStatusCode":429}, + "exception":true + }, "Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json b/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json index 72d4cb00388..bcb87cad754 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json @@ -3,16 +3,16 @@ "service": "

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

", "operations": { "AssociateAttributeGroup": "

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

", - "AssociateResource": "

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

", + "AssociateResource": "

Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.

", "CreateApplication": "

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

", "CreateAttributeGroup": "

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

", - "DeleteApplication": "

Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application.

", - "DeleteAttributeGroup": "

Deletes an attribute group, specified either by its attribute group ID or name.

", + "DeleteApplication": "

Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

", + "DeleteAttributeGroup": "

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

", "DisassociateAttributeGroup": "

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup.

", "DisassociateResource": "

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

", - "GetApplication": "

Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

", + "GetApplication": "

Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

", "GetAssociatedResource": "

Gets the resource associated with the application.

", - "GetAttributeGroup": "

Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.

", + "GetAttributeGroup": "

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

", "GetConfiguration": "

Retrieves a TagKey configuration from an account.

", "ListApplications": "

Retrieves a list of all of your applications. Results are paginated.

", "ListAssociatedAttributeGroups": "

Lists all attribute groups that are associated with specified application. Results are paginated.

", @@ -29,7 +29,7 @@ }, "shapes": { "AppRegistryConfiguration": { - "base": "

Includes all of the Service Catalog AppRegistry settings.

", + "base": "

Includes all of the AppRegistry settings.

", "refs": { "GetConfigurationResponse$configuration": "

Retrieves TagKey configuration from an account.

", "PutConfigurationRequest$configuration": "

Associates a TagKey configuration to an account.

" @@ -66,17 +66,17 @@ "ApplicationSpecifier": { "base": null, "refs": { - "AssociateAttributeGroupRequest$application": "

The name or ID of the application.

", - "AssociateResourceRequest$application": "

The name or ID of the application.

", - "DeleteApplicationRequest$application": "

The name or ID of the application.

", - "DisassociateAttributeGroupRequest$application": "

The name or ID of the application.

", + "AssociateAttributeGroupRequest$application": "

The name, ID, or ARN of the application.

", + "AssociateResourceRequest$application": "

The name, ID, or ARN of the application.

", + "DeleteApplicationRequest$application": "

The name, ID, or ARN of the application.

", + "DisassociateAttributeGroupRequest$application": "

The name, ID, or ARN of the application.

", "DisassociateResourceRequest$application": "

The name or ID of the application.

", - "GetApplicationRequest$application": "

The name or ID of the application.

", - "GetAssociatedResourceRequest$application": "

The name or ID of the application.

", + "GetApplicationRequest$application": "

The name, ID, or ARN of the application.

", + "GetAssociatedResourceRequest$application": "

The name, ID, or ARN of the application.

", "ListAssociatedAttributeGroupsRequest$application": "

The name or ID of the application.

", - "ListAssociatedResourcesRequest$application": "

The name or ID of the application.

", + "ListAssociatedResourcesRequest$application": "

The name, ID, or ARN of the application.

", "ListAttributeGroupsForApplicationRequest$application": "

The name or ID of the application.

", - "UpdateApplicationRequest$application": "

The name or ID of the application that will be updated.

" + "UpdateApplicationRequest$application": "

The name, ID, or ARN of the application that will be updated.

" } }, "ApplicationSummaries": { @@ -180,11 +180,11 @@ "AttributeGroupSpecifier": { "base": null, "refs": { - "AssociateAttributeGroupRequest$attributeGroup": "

The name or ID of the attribute group that holds the attributes to describe the application.

", - "DeleteAttributeGroupRequest$attributeGroup": "

The name or ID of the attribute group that holds the attributes to describe the application.

", - "DisassociateAttributeGroupRequest$attributeGroup": "

The name or ID of the attribute group that holds the attributes to describe the application.

", - "GetAttributeGroupRequest$attributeGroup": "

The name or ID of the attribute group that holds the attributes to describe the application.

", - "UpdateAttributeGroupRequest$attributeGroup": "

The name or ID of the attribute group that holds the attributes to describe the application.

" + "AssociateAttributeGroupRequest$attributeGroup": "

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

", + "DeleteAttributeGroupRequest$attributeGroup": "

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

", + "DisassociateAttributeGroupRequest$attributeGroup": "

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

", + "GetAttributeGroupRequest$attributeGroup": "

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

", + "UpdateAttributeGroupRequest$attributeGroup": "

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

" } }, "AttributeGroupSummaries": { @@ -240,6 +240,14 @@ "refs": { } }, + "CreatedBy": { + "base": null, + "refs": { + "AttributeGroupDetails$createdBy": "

The service principal that created the attribute group.

", + "AttributeGroupSummary$createdBy": "

The service principal that created the attribute group.

", + "GetAttributeGroupResponse$createdBy": "

The service principal that created the attribute group.

" + } + }, "DeleteApplicationRequest": { "base": null, "refs": { @@ -517,7 +525,7 @@ } }, "ServiceQuotaExceededException": { - "base": "

The maximum number of resources per account has been reached.

", + "base": "

The maximum number of resources per account has been reached.

", "refs": { } }, @@ -535,6 +543,8 @@ "ResourceGroup$errorMessage": "

The error message that generates when the propagation process for the resource group fails.

", "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, + "ThrottlingException$message": "

A message associated with the Throttling exception.

", + "ThrottlingException$serviceCode": "

The originating service code.

", "ValidationException$message": null } }, @@ -609,6 +619,11 @@ "TagResourceRequest$tags": "

The new or modified tags for the resource.

" } }, + "ThrottlingException": { + "base": "

The maximum number of API requests has been exceeded.

", + "refs": { + } + }, "Timestamp": { "base": null, "refs": { diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json index e2b677e60fb..c68661173d4 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-rule-set-1.json @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,199 +111,263 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ - "aws-us-gov", + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] } ] } ], - "endpoint": { - "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://servicecatalog-appregistry.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json index 07278e2be4a..6f23719cc0f 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/endpoint-tests-1.json @@ -1,408 +1,5 @@ { "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "af-south-1" - } - }, { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { @@ -411,464 +8,230 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-north-1.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-north-1" + "Region": "af-south-1" } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.eu-north-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-3.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" + "Region": "ap-east-1" } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-3.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-northeast-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-2" + "Region": "ap-northeast-1" } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-2.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-northeast-2.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.eu-west-1.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-1" + "Region": "ap-northeast-2" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.eu-west-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-northeast-3.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": true, "Region": "ap-northeast-3" } }, { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-3.api.aws" + "url": "https://servicecatalog-appregistry.ap-south-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-3.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-south-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-2.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-southeast-1.amazonaws.com" } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-southeast-1" } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-2.api.aws" + "url": "https://servicecatalog-appregistry.ap-southeast-2.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-2.amazonaws.com" - } - }, - "params": { "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-southeast-2" } }, { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-northeast-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.ap-southeast-3.amazonaws.com" } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-southeast-3" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-1.api.aws" + "url": "https://servicecatalog-appregistry.ca-central-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false, + "Region": "ca-central-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-northeast-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.ca-central-1.amazonaws.com" } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ca-central-1" } }, { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.me-south-1.api.aws" + "url": "https://servicecatalog-appregistry.eu-central-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "me-south-1" + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-1" } }, { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.me-south-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.eu-north-1.amazonaws.com" } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true, - "Region": "me-south-1" + "Region": "eu-north-1" } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.me-south-1.api.aws" + "url": "https://servicecatalog-appregistry.eu-south-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false, + "Region": "eu-south-1" } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.me-south-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.eu-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false, + "Region": "eu-west-1" } }, { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.sa-east-1.api.aws" + "url": "https://servicecatalog-appregistry.eu-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "sa-east-1" + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-2" } }, { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.sa-east-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.eu-west-3.amazonaws.com" } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true, - "Region": "sa-east-1" + "Region": "eu-west-3" } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.sa-east-1.api.aws" + "url": "https://servicecatalog-appregistry.me-south-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -879,386 +242,378 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1" } }, { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-east-1.api.aws" + "url": "https://servicecatalog-appregistry.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-east-1" + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1" } }, { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-east-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "UseDualStack": false, + "Region": "us-east-1" } }, { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-east-1.api.aws" + "url": "https://servicecatalog-appregistry.us-east-2.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false, + "Region": "us-east-2" } }, { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-east-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.us-east-2.amazonaws.com" } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-east-1" + "Region": "us-east-2" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-gov-west-1.api.aws" + "url": "https://servicecatalog-appregistry.us-west-1.amazonaws.com" } }, "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-west-1" + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-west-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.us-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "UseDualStack": false, + "Region": "us-west-1" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-west-1.api.aws" + "url": "https://servicecatalog-appregistry.us-west-2.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false, + "Region": "us-west-2" } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-gov-west-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.us-west-2.amazonaws.com" } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-west-2" } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-1.api.aws" + "url": "https://servicecatalog-appregistry-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "UseDualStack": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-1.amazonaws.com" + "url": "https://servicecatalog-appregistry.us-east-1.api.aws" } }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-1.api.aws" + "url": "https://servicecatalog-appregistry-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-1.amazonaws.com" + "url": "https://servicecatalog-appregistry-fips.cn-north-1.amazonaws.com.cn" } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-2.api.aws" + "url": "https://servicecatalog-appregistry.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-2.amazonaws.com" + "url": "https://servicecatalog-appregistry.cn-north-1.amazonaws.com.cn" } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "cn-north-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-2.api.aws" + "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-2.amazonaws.com" + "url": "https://servicecatalog-appregistry.us-gov-west-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-3.api.aws" + "url": "https://servicecatalog-appregistry-fips.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.ap-southeast-3.amazonaws.com" + "url": "https://servicecatalog-appregistry.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-3.api.aws" + "url": "https://servicecatalog-appregistry.us-gov-east-1.api.aws" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.ap-southeast-3.amazonaws.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-3" + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-east-1.api.aws" + "url": "https://servicecatalog-appregistry-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-east-1.amazonaws.com" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-east-1.api.aws" + "url": "https://servicecatalog-appregistry.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry.us-east-1.amazonaws.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-east-2.api.aws" + "url": "https://servicecatalog-appregistry-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://servicecatalog-appregistry-fips.us-east-2.amazonaws.com" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-east-2.api.aws" + "url": "https://servicecatalog-appregistry.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://servicecatalog-appregistry.us-east-2.amazonaws.com" + "url": "https://example.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1268,8 +623,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1280,11 +635,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/voice-id/2021-09-27/api-2.json b/models/apis/voice-id/2021-09-27/api-2.json index eb4e56f8e6b..d90cd3682fe 100644 --- a/models/apis/voice-id/2021-09-27/api-2.json +++ b/models/apis/voice-id/2021-09-27/api-2.json @@ -13,6 +13,24 @@ "uid":"voice-id-2021-09-27" }, "operations":{ + "AssociateFraudster":{ + "name":"AssociateFraudster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateFraudsterRequest"}, + "output":{"shape":"AssociateFraudsterResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "CreateDomain":{ "name":"CreateDomain", "http":{ @@ -32,6 +50,25 @@ ], "idempotent":true }, + "CreateWatchlist":{ + "name":"CreateWatchlist", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWatchlistRequest"}, + "output":{"shape":"CreateWatchlistResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ @@ -81,6 +118,22 @@ {"shape":"AccessDeniedException"} ] }, + "DeleteWatchlist":{ + "name":"DeleteWatchlist", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWatchlistRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ @@ -161,6 +214,39 @@ {"shape":"AccessDeniedException"} ] }, + "DescribeWatchlist":{ + "name":"DescribeWatchlist", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWatchlistRequest"}, + "output":{"shape":"DescribeWatchlistResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DisassociateFraudster":{ + "name":"DisassociateFraudster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateFraudsterRequest"}, + "output":{"shape":"DisassociateFraudsterResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "EvaluateSession":{ "name":"EvaluateSession", "http":{ @@ -209,6 +295,22 @@ {"shape":"AccessDeniedException"} ] }, + "ListFraudsters":{ + "name":"ListFraudsters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFraudstersRequest"}, + "output":{"shape":"ListFraudstersResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "ListSpeakerEnrollmentJobs":{ "name":"ListSpeakerEnrollmentJobs", "http":{ @@ -257,6 +359,22 @@ {"shape":"AccessDeniedException"} ] }, + "ListWatchlists":{ + "name":"ListWatchlists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWatchlistsRequest"}, + "output":{"shape":"ListWatchlistsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "OptOutSpeaker":{ "name":"OptOutSpeaker", "http":{ @@ -363,6 +481,23 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ] + }, + "UpdateWatchlist":{ + "name":"UpdateWatchlist", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWatchlistRequest"}, + "output":{"shape":"UpdateWatchlistResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] } }, "shapes":{ @@ -383,6 +518,25 @@ "type":"string", "pattern":"^arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}$" }, + "AssociateFraudsterRequest":{ + "type":"structure", + "required":[ + "DomainId", + "FraudsterId", + "WatchlistId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "FraudsterId":{"shape":"FraudsterId"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "AssociateFraudsterResponse":{ + "type":"structure", + "members":{ + "Fraudster":{"shape":"Fraudster"} + } + }, "AuthenticationConfiguration":{ "type":"structure", "required":["AcceptanceThreshold"], @@ -415,6 +569,7 @@ "Score":{"shape":"Score"} } }, + "Boolean":{"type":"boolean"}, "ClientTokenString":{ "type":"string", "max":64, @@ -439,7 +594,9 @@ "SPEAKER_NOT_SET", "SPEAKER_OPTED_OUT", "CONCURRENT_CHANGES", - "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES" + "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES", + "CANNOT_DELETE_NON_EMPTY_WATCHLIST", + "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST" ] }, "CreateDomainRequest":{ @@ -465,6 +622,28 @@ "Domain":{"shape":"Domain"} } }, + "CreateWatchlistRequest":{ + "type":"structure", + "required":[ + "DomainId", + "Name" + ], + "members":{ + "ClientToken":{ + "shape":"ClientTokenString", + "idempotencyToken":true + }, + "Description":{"shape":"WatchlistDescription"}, + "DomainId":{"shape":"DomainId"}, + "Name":{"shape":"WatchlistName"} + } + }, + "CreateWatchlistResponse":{ + "type":"structure", + "members":{ + "Watchlist":{"shape":"Watchlist"} + } + }, "CustomerSpeakerId":{ "type":"string", "max":256, @@ -501,6 +680,17 @@ "SpeakerId":{"shape":"SpeakerId"} } }, + "DeleteWatchlistRequest":{ + "type":"structure", + "required":[ + "DomainId", + "WatchlistId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, "DescribeDomainRequest":{ "type":"structure", "required":["DomainId"], @@ -582,6 +772,23 @@ "Speaker":{"shape":"Speaker"} } }, + "DescribeWatchlistRequest":{ + "type":"structure", + "required":[ + "DomainId", + "WatchlistId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "DescribeWatchlistResponse":{ + "type":"structure", + "members":{ + "Watchlist":{"shape":"Watchlist"} + } + }, "Description":{ "type":"string", "max":1024, @@ -589,6 +796,25 @@ "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$", "sensitive":true }, + "DisassociateFraudsterRequest":{ + "type":"structure", + "required":[ + "DomainId", + "FraudsterId", + "WatchlistId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "FraudsterId":{"shape":"FraudsterId"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "DisassociateFraudsterResponse":{ + "type":"structure", + "members":{ + "Fraudster":{"shape":"Fraudster"} + } + }, "Domain":{ "type":"structure", "members":{ @@ -600,7 +826,8 @@ "Name":{"shape":"DomainName"}, "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, "ServerSideEncryptionUpdateDetails":{"shape":"ServerSideEncryptionUpdateDetails"}, - "UpdatedAt":{"shape":"Timestamp"} + "UpdatedAt":{"shape":"Timestamp"}, + "WatchlistDetails":{"shape":"WatchlistDetails"} } }, "DomainId":{ @@ -639,7 +866,8 @@ "Name":{"shape":"DomainName"}, "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, "ServerSideEncryptionUpdateDetails":{"shape":"ServerSideEncryptionUpdateDetails"}, - "UpdatedAt":{"shape":"Timestamp"} + "UpdatedAt":{"shape":"Timestamp"}, + "WatchlistDetails":{"shape":"WatchlistDetails"} } }, "DuplicateRegistrationAction":{ @@ -660,9 +888,16 @@ "type":"structure", "members":{ "FraudDetectionAction":{"shape":"FraudDetectionAction"}, - "RiskThreshold":{"shape":"Score"} + "RiskThreshold":{"shape":"Score"}, + "WatchlistIds":{"shape":"EnrollmentJobFraudDetectionConfigWatchlistIds"} } }, + "EnrollmentJobFraudDetectionConfigWatchlistIds":{ + "type":"list", + "member":{"shape":"WatchlistId"}, + "max":1, + "min":1 + }, "EvaluateSessionRequest":{ "type":"structure", "required":[ @@ -708,9 +943,9 @@ }, "FraudDetectionConfiguration":{ "type":"structure", - "required":["RiskThreshold"], "members":{ - "RiskThreshold":{"shape":"Score"} + "RiskThreshold":{"shape":"Score"}, + "WatchlistId":{"shape":"WatchlistId"} } }, "FraudDetectionDecision":{ @@ -762,7 +997,8 @@ "members":{ "CreatedAt":{"shape":"Timestamp"}, "DomainId":{"shape":"DomainId"}, - "GeneratedFraudsterId":{"shape":"GeneratedFraudsterId"} + "GeneratedFraudsterId":{"shape":"GeneratedFraudsterId"}, + "WatchlistIds":{"shape":"ResponseWatchlistIds"} } }, "FraudsterId":{ @@ -816,6 +1052,19 @@ "JobStatus":{"shape":"FraudsterRegistrationJobStatus"} } }, + "FraudsterSummaries":{ + "type":"list", + "member":{"shape":"FraudsterSummary"} + }, + "FraudsterSummary":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DomainId":{"shape":"DomainId"}, + "GeneratedFraudsterId":{"shape":"GeneratedFraudsterId"}, + "WatchlistIds":{"shape":"ResponseWatchlistIds"} + } + }, "GeneratedFraudsterId":{ "type":"string", "max":25, @@ -916,6 +1165,23 @@ "NextToken":{"shape":"String"} } }, + "ListFraudstersRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"}, + "MaxResults":{"shape":"MaxResultsForList"}, + "NextToken":{"shape":"NextToken"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "ListFraudstersResponse":{ + "type":"structure", + "members":{ + "FraudsterSummaries":{"shape":"FraudsterSummaries"}, + "NextToken":{"shape":"String"} + } + }, "ListSpeakerEnrollmentJobsRequest":{ "type":"structure", "required":["DomainId"], @@ -962,6 +1228,22 @@ "Tags":{"shape":"TagList"} } }, + "ListWatchlistsRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"}, + "MaxResults":{"shape":"MaxResultsForList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListWatchlistsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"String"}, + "WatchlistSummaries":{"shape":"WatchlistSummaries"} + } + }, "MaxResultsForList":{ "type":"integer", "box":true, @@ -1009,9 +1291,16 @@ "type":"structure", "members":{ "DuplicateRegistrationAction":{"shape":"DuplicateRegistrationAction"}, - "FraudsterSimilarityThreshold":{"shape":"Score"} + "FraudsterSimilarityThreshold":{"shape":"Score"}, + "WatchlistIds":{"shape":"RegistrationConfigWatchlistIds"} } }, + "RegistrationConfigWatchlistIds":{ + "type":"list", + "member":{"shape":"WatchlistId"}, + "max":1, + "min":1 + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -1028,9 +1317,14 @@ "DOMAIN", "FRAUDSTER", "SESSION", - "SPEAKER" + "SPEAKER", + "WATCHLIST" ] }, + "ResponseWatchlistIds":{ + "type":"list", + "member":{"shape":"WatchlistId"} + }, "S3Uri":{ "type":"string", "max":1024, @@ -1348,6 +1642,25 @@ "Domain":{"shape":"Domain"} } }, + "UpdateWatchlistRequest":{ + "type":"structure", + "required":[ + "DomainId", + "WatchlistId" + ], + "members":{ + "Description":{"shape":"WatchlistDescription"}, + "DomainId":{"shape":"DomainId"}, + "Name":{"shape":"WatchlistName"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "UpdateWatchlistResponse":{ + "type":"structure", + "members":{ + "Watchlist":{"shape":"Watchlist"} + } + }, "ValidationException":{ "type":"structure", "members":{ @@ -1361,6 +1674,61 @@ "members":{ "RiskScore":{"shape":"Score"} } + }, + "Watchlist":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DefaultWatchlist":{"shape":"Boolean"}, + "Description":{"shape":"WatchlistDescription"}, + "DomainId":{"shape":"DomainId"}, + "Name":{"shape":"WatchlistName"}, + "UpdatedAt":{"shape":"Timestamp"}, + "WatchlistId":{"shape":"WatchlistId"} + } + }, + "WatchlistDescription":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$", + "sensitive":true + }, + "WatchlistDetails":{ + "type":"structure", + "required":["DefaultWatchlistId"], + "members":{ + "DefaultWatchlistId":{"shape":"WatchlistId"} + } + }, + "WatchlistId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[a-zA-Z0-9]{22}$" + }, + "WatchlistName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "sensitive":true + }, + "WatchlistSummaries":{ + "type":"list", + "member":{"shape":"WatchlistSummary"} + }, + "WatchlistSummary":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DefaultWatchlist":{"shape":"Boolean"}, + "Description":{"shape":"WatchlistDescription"}, + "DomainId":{"shape":"DomainId"}, + "Name":{"shape":"WatchlistName"}, + "UpdatedAt":{"shape":"Timestamp"}, + "WatchlistId":{"shape":"WatchlistId"} + } } } } diff --git a/models/apis/voice-id/2021-09-27/docs-2.json b/models/apis/voice-id/2021-09-27/docs-2.json index f410d597044..67021fbab30 100644 --- a/models/apis/voice-id/2021-09-27/docs-2.json +++ b/models/apis/voice-id/2021-09-27/docs-2.json @@ -1,28 +1,36 @@ { "version": "2.0", - "service": "

Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.

", + "service": "

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.

", "operations": { - "CreateDomain": "

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

", + "AssociateFraudster": "

Associates the fraudsters with the watchlist specified in the same domain.

", + "CreateDomain": "

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

", + "CreateWatchlist": "

Creates a watchlist that fraudsters can be a part of.

", "DeleteDomain": "

Deletes the specified domain from Voice ID.

", - "DeleteFraudster": "

Deletes the specified fraudster from Voice ID.

", + "DeleteFraudster": "

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

", "DeleteSpeaker": "

Deletes the specified speaker from Voice ID.

", + "DeleteWatchlist": "

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

", "DescribeDomain": "

Describes the specified domain.

", "DescribeFraudster": "

Describes the specified fraudster.

", "DescribeFraudsterRegistrationJob": "

Describes the specified fraudster registration job.

", "DescribeSpeaker": "

Describes the specified speaker.

", "DescribeSpeakerEnrollmentJob": "

Describes the specified speaker enrollment job.

", + "DescribeWatchlist": "

Describes the specified watchlist.

", + "DisassociateFraudster": "

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

", "EvaluateSession": "

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

", "ListDomains": "

Lists all the domains in the Amazon Web Services account.

", "ListFraudsterRegistrationJobs": "

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

", + "ListFraudsters": "

Lists all fraudsters in a specified watchlist or domain.

", "ListSpeakerEnrollmentJobs": "

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

", "ListSpeakers": "

Lists all speakers in a specified domain.

", "ListTagsForResource": "

Lists all tags associated with a specified Voice ID resource.

", + "ListWatchlists": "

Lists all watchlists in a specified domain.

", "OptOutSpeaker": "

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

", "StartFraudsterRegistrationJob": "

Starts a new batch fraudster registration job using provided details.

", "StartSpeakerEnrollmentJob": "

Starts a new batch speaker enrollment job using specified details.

", "TagResource": "

Tags a Voice ID resource with the provided list of tags.

", "UntagResource": "

Removes specified tags from a specified Amazon Connect Voice ID resource.

", - "UpdateDomain": "

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

" + "UpdateDomain": "

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

", + "UpdateWatchlist": "

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.

" }, "shapes": { "AccessDeniedException": { @@ -45,6 +53,16 @@ "DomainSummary$Arn": "

The Amazon Resource Name (ARN) for the domain.

" } }, + "AssociateFraudsterRequest": { + "base": null, + "refs": { + } + }, + "AssociateFraudsterResponse": { + "base": null, + "refs": { + } + }, "AuthenticationConfiguration": { "base": "

The configuration used to authenticate a speaker during a session.

", "refs": { @@ -63,12 +81,20 @@ "EvaluateSessionResponse$AuthenticationResult": "

Details resulting from the authentication process, such as authentication decision and authentication score.

" } }, + "Boolean": { + "base": null, + "refs": { + "Watchlist$DefaultWatchlist": "

Whether the specified watchlist is the default watchlist of a domain.

", + "WatchlistSummary$DefaultWatchlist": "

Whether the specified watchlist is the default watchlist of a domain.

" + } + }, "ClientTokenString": { "base": null, "refs": { - "CreateDomainRequest$ClientToken": "

The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.

", - "StartFraudsterRegistrationJobRequest$ClientToken": "

The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

", - "StartSpeakerEnrollmentJobRequest$ClientToken": "

The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

" + "CreateDomainRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "CreateWatchlistRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "StartFraudsterRegistrationJobRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

", + "StartSpeakerEnrollmentJobRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

" } }, "ConflictException": { @@ -92,6 +118,16 @@ "refs": { } }, + "CreateWatchlistRequest": { + "base": null, + "refs": { + } + }, + "CreateWatchlistResponse": { + "base": null, + "refs": { + } + }, "CustomerSpeakerId": { "base": null, "refs": { @@ -115,6 +151,11 @@ "refs": { } }, + "DeleteWatchlistRequest": { + "base": null, + "refs": { + } + }, "DescribeDomainRequest": { "base": null, "refs": { @@ -165,13 +206,33 @@ "refs": { } }, + "DescribeWatchlistRequest": { + "base": null, + "refs": { + } + }, + "DescribeWatchlistResponse": { + "base": null, + "refs": { + } + }, "Description": { "base": null, "refs": { - "CreateDomainRequest$Description": "

A brief description of the domain.

", - "Domain$Description": "

The client-provided description of the domain.

", - "DomainSummary$Description": "

The client-provided description of the domain.

", - "UpdateDomainRequest$Description": "

A brief description of the domain.

" + "CreateDomainRequest$Description": "

A brief description of this domain.

", + "Domain$Description": "

The description of the domain.

", + "DomainSummary$Description": "

The description of the domain.

", + "UpdateDomainRequest$Description": "

A brief description about this domain.

" + } + }, + "DisassociateFraudsterRequest": { + "base": null, + "refs": { + } + }, + "DisassociateFraudsterResponse": { + "base": null, + "refs": { } }, "Domain": { @@ -185,39 +246,50 @@ "DomainId": { "base": null, "refs": { + "AssociateFraudsterRequest$DomainId": "

The identifier of the domain that contains the fraudster.

", + "CreateWatchlistRequest$DomainId": "

The identifier of the domain that contains the watchlist.

", "DeleteDomainRequest$DomainId": "

The identifier of the domain you want to delete.

", - "DeleteFraudsterRequest$DomainId": "

The identifier of the domain containing the fraudster.

", - "DeleteSpeakerRequest$DomainId": "

The identifier of the domain containing the speaker.

", - "DescribeDomainRequest$DomainId": "

The identifier of the domain you are describing.

", - "DescribeFraudsterRegistrationJobRequest$DomainId": "

The identifier for the domain containing the fraudster registration job.

", - "DescribeFraudsterRequest$DomainId": "

The identifier of the domain containing the fraudster.

", - "DescribeSpeakerEnrollmentJobRequest$DomainId": "

The identifier of the domain containing the speaker enrollment job.

", + "DeleteFraudsterRequest$DomainId": "

The identifier of the domain that contains the fraudster.

", + "DeleteSpeakerRequest$DomainId": "

The identifier of the domain that contains the speaker.

", + "DeleteWatchlistRequest$DomainId": "

The identifier of the domain that contains the watchlist.

", + "DescribeDomainRequest$DomainId": "

The identifier of the domain that you are describing.

", + "DescribeFraudsterRegistrationJobRequest$DomainId": "

The identifier of the domain that contains the fraudster registration job.

", + "DescribeFraudsterRequest$DomainId": "

The identifier of the domain that contains the fraudster.

", + "DescribeSpeakerEnrollmentJobRequest$DomainId": "

The identifier of the domain that contains the speaker enrollment job.

", "DescribeSpeakerRequest$DomainId": "

The identifier of the domain that contains the speaker.

", - "Domain$DomainId": "

The service-generated identifier for the domain.

", - "DomainSummary$DomainId": "

The service-generated identifier for the domain.

", + "DescribeWatchlistRequest$DomainId": "

The identifier of the domain that contains the watchlist.

", + "DisassociateFraudsterRequest$DomainId": "

The identifier of the domain that contains the fraudster.

", + "Domain$DomainId": "

The identifier of the domain.

", + "DomainSummary$DomainId": "

The identifier of the domain.

", "EvaluateSessionRequest$DomainId": "

The identifier of the domain where the session started.

", - "EvaluateSessionResponse$DomainId": "

The identifier of the domain containing the session.

", - "Fraudster$DomainId": "

The identifier for the domain containing the fraudster.

", - "FraudsterRegistrationJob$DomainId": "

The identifier of the domain containing the fraudster registration job.

", - "FraudsterRegistrationJobSummary$DomainId": "

The identifier of the domain containing the fraudster registration job.

", - "ListFraudsterRegistrationJobsRequest$DomainId": "

The identifier of the domain containing the fraudster registration Jobs.

", - "ListSpeakerEnrollmentJobsRequest$DomainId": "

The identifier of the domain containing the speaker enrollment jobs.

", + "EvaluateSessionResponse$DomainId": "

The identifier of the domain that contains the session.

", + "Fraudster$DomainId": "

The identifier of the domain that contains the fraudster.

", + "FraudsterRegistrationJob$DomainId": "

The identifier of the domain that contains the fraudster registration job.

", + "FraudsterRegistrationJobSummary$DomainId": "

The identifier of the domain that contains the fraudster registration job.

", + "FraudsterSummary$DomainId": "

The identifier of the domain that contains the fraudster summary.

", + "ListFraudsterRegistrationJobsRequest$DomainId": "

The identifier of the domain that contains the fraudster registration Jobs.

", + "ListFraudstersRequest$DomainId": "

The identifier of the domain.

", + "ListSpeakerEnrollmentJobsRequest$DomainId": "

The identifier of the domain that contains the speaker enrollment jobs.

", "ListSpeakersRequest$DomainId": "

The identifier of the domain.

", - "OptOutSpeakerRequest$DomainId": "

The identifier of the domain containing the speaker.

", + "ListWatchlistsRequest$DomainId": "

The identifier of the domain.

", + "OptOutSpeakerRequest$DomainId": "

The identifier of the domain that contains the speaker.

", "Speaker$DomainId": "

The identifier of the domain that contains the speaker.

", "SpeakerEnrollmentJob$DomainId": "

The identifier of the domain that contains the speaker enrollment job.

", "SpeakerEnrollmentJobSummary$DomainId": "

The identifier of the domain that contains the speaker enrollment job.

", "SpeakerSummary$DomainId": "

The identifier of the domain that contains the speaker.

", - "StartFraudsterRegistrationJobRequest$DomainId": "

The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.

", + "StartFraudsterRegistrationJobRequest$DomainId": "

The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.

", "StartSpeakerEnrollmentJobRequest$DomainId": "

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

", - "UpdateDomainRequest$DomainId": "

The identifier of the domain to be updated.

" + "UpdateDomainRequest$DomainId": "

The identifier of the domain to be updated.

", + "UpdateWatchlistRequest$DomainId": "

The identifier of the domain that contains the watchlist.

", + "Watchlist$DomainId": "

The identifier of the domain that contains the watchlist.

", + "WatchlistSummary$DomainId": "

The identifier of the domain that contains the watchlist.

" } }, "DomainName": { "base": null, "refs": { "CreateDomainRequest$Name": "

The name of the domain.

", - "Domain$Name": "

The client-provided name for the domain.

", + "Domain$Name": "

The name for the domain.

", "DomainSummary$Name": "

The client-provided name for the domain.

", "UpdateDomainRequest$Name": "

The name of the domain.

" } @@ -255,11 +327,17 @@ } }, "EnrollmentJobFraudDetectionConfig": { - "base": "

The configuration defining the action to take when a speaker is flagged by the fraud detection system during a batch speaker enrollment job, and the risk threshold to use for identification.

", + "base": "

The fraud detection configuration to be used during the batch speaker enrollment job.

", "refs": { "EnrollmentConfig$FraudDetectionConfig": "

The fraud detection configuration to use for the speaker enrollment job.

" } }, + "EnrollmentJobFraudDetectionConfigWatchlistIds": { + "base": null, + "refs": { + "EnrollmentJobFraudDetectionConfig$WatchlistIds": "

The identifier of watchlists against which fraud detection is performed.

" + } + }, "EvaluateSessionRequest": { "base": null, "refs": { @@ -330,14 +408,18 @@ "Fraudster": { "base": "

Contains all the information about a fraudster.

", "refs": { - "DescribeFraudsterResponse$Fraudster": "

Information about the specified fraudster.

" + "AssociateFraudsterResponse$Fraudster": null, + "DescribeFraudsterResponse$Fraudster": "

Information about the specified fraudster.

", + "DisassociateFraudsterResponse$Fraudster": null } }, "FraudsterId": { "base": null, "refs": { + "AssociateFraudsterRequest$FraudsterId": "

The identifier of the fraudster to be associated with the watchlist.

", "DeleteFraudsterRequest$FraudsterId": "

The identifier of the fraudster you want to delete.

", - "DescribeFraudsterRequest$FraudsterId": "

The identifier of the fraudster you are describing.

" + "DescribeFraudsterRequest$FraudsterId": "

The identifier of the fraudster you are describing.

", + "DisassociateFraudsterRequest$FraudsterId": "

The identifier of the fraudster to be disassociated from the watchlist.

" } }, "FraudsterRegistrationJob": { @@ -367,10 +449,23 @@ "FraudsterRegistrationJobSummaries$member": null } }, + "FraudsterSummaries": { + "base": null, + "refs": { + "ListFraudstersResponse$FraudsterSummaries": "

A list that contains details about each fraudster in the Amazon Web Services account.

" + } + }, + "FraudsterSummary": { + "base": "

Contains a summary of information about a fraudster.

", + "refs": { + "FraudsterSummaries$member": null + } + }, "GeneratedFraudsterId": { "base": null, "refs": { "Fraudster$GeneratedFraudsterId": "

The service-generated identifier for the fraudster.

", + "FraudsterSummary$GeneratedFraudsterId": "

The service-generated identifier for the fraudster.

", "KnownFraudsterRisk$GeneratedFraudsterId": "

The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is null.

" } }, @@ -414,7 +509,7 @@ "JobId": { "base": null, "refs": { - "DescribeFraudsterRegistrationJobRequest$JobId": "

The identifier for the fraudster registration job you are describing.

", + "DescribeFraudsterRegistrationJobRequest$JobId": "

The identifier of the fraudster registration job you are describing.

", "DescribeSpeakerEnrollmentJobRequest$JobId": "

The identifier of the speaker enrollment job you are describing.

", "FraudsterRegistrationJob$JobId": "

The service-generated identifier for the fraudster registration job.

", "FraudsterRegistrationJobSummary$JobId": "

The service-generated identifier for the fraudster registration job.

", @@ -476,6 +571,16 @@ "refs": { } }, + "ListFraudstersRequest": { + "base": null, + "refs": { + } + }, + "ListFraudstersResponse": { + "base": null, + "refs": { + } + }, "ListSpeakerEnrollmentJobsRequest": { "base": null, "refs": { @@ -506,27 +611,41 @@ "refs": { } }, + "ListWatchlistsRequest": { + "base": null, + "refs": { + } + }, + "ListWatchlistsResponse": { + "base": null, + "refs": { + } + }, "MaxResultsForList": { "base": null, "refs": { - "ListFraudsterRegistrationJobsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

", - "ListSpeakerEnrollmentJobsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

", - "ListSpeakersRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.

" + "ListFraudsterRegistrationJobsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

", + "ListFraudstersRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

", + "ListSpeakerEnrollmentJobsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

", + "ListSpeakersRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

", + "ListWatchlistsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

" } }, "MaxResultsForListDomainFe": { "base": null, "refs": { - "ListDomainsRequest$MaxResults": "

The maximum number of domains to list per API call.

" + "ListDomainsRequest$MaxResults": "

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

" } }, "NextToken": { "base": null, "refs": { - "ListDomainsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", - "ListFraudsterRegistrationJobsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", - "ListSpeakerEnrollmentJobsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", - "ListSpeakersRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

" + "ListDomainsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListFraudsterRegistrationJobsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListFraudstersRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListSpeakerEnrollmentJobsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListSpeakersRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListWatchlistsRequest$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

" } }, "OptOutSpeakerRequest": { @@ -549,12 +668,18 @@ } }, "RegistrationConfig": { - "base": "

The configuration defining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

", + "base": "

The registration configuration to be used during the batch fraudster registration job.

", "refs": { "FraudsterRegistrationJob$RegistrationConfig": "

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

", "StartFraudsterRegistrationJobRequest$RegistrationConfig": "

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

" } }, + "RegistrationConfigWatchlistIds": { + "base": null, + "refs": { + "RegistrationConfig$WatchlistIds": "

The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.

" + } + }, "ResourceNotFoundException": { "base": "

The specified resource cannot be found. Check the ResourceType and error message for more details.

", "refs": { @@ -566,6 +691,13 @@ "ResourceNotFoundException$ResourceType": "

The type of resource which cannot not be found. Possible types are BATCH_JOB, COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and SPEAKER.

" } }, + "ResponseWatchlistIds": { + "base": null, + "refs": { + "Fraudster$WatchlistIds": "

The identifier of the watchlists the fraudster is a part of.

", + "FraudsterSummary$WatchlistIds": "

The identifier of the watchlists the fraudster is a part of.

" + } + }, "S3Uri": { "base": null, "refs": { @@ -725,10 +857,12 @@ "ConflictException$Message": null, "FailureDetails$Message": "

A description of the error that caused the batch job failure.

", "InternalServerException$Message": null, - "ListDomainsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", - "ListFraudsterRegistrationJobsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListDomainsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListFraudsterRegistrationJobsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListFraudstersResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", "ListSpeakerEnrollmentJobsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", "ListSpeakersResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", + "ListWatchlistsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", "ResourceNotFoundException$Message": null, "ServerSideEncryptionUpdateDetails$Message": "

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

", "ServiceQuotaExceededException$Message": null, @@ -787,29 +921,34 @@ "Timestamp": { "base": null, "refs": { - "AuthenticationResult$AudioAggregationEndedAt": "

A timestamp indicating when audio aggregation ended for this authentication result.

", - "AuthenticationResult$AudioAggregationStartedAt": "

A timestamp indicating when audio aggregation started for this authentication result.

", - "Domain$CreatedAt": "

The timestamp at which the domain is created.

", - "Domain$UpdatedAt": "

The timestamp showing the domain's last update.

", - "DomainSummary$CreatedAt": "

The timestamp showing when the domain is created.

", - "DomainSummary$UpdatedAt": "

The timestamp showing the domain's last update.

", - "FraudDetectionResult$AudioAggregationEndedAt": "

A timestamp indicating when audio aggregation ended for this fraud detection result.

", - "FraudDetectionResult$AudioAggregationStartedAt": "

A timestamp indicating when audio aggregation started for this fraud detection result.

", - "Fraudster$CreatedAt": "

The timestamp when Voice ID identified the fraudster.

", - "FraudsterRegistrationJob$CreatedAt": "

A timestamp showing the creation time of the fraudster registration job.

", - "FraudsterRegistrationJob$EndedAt": "

A timestamp showing when the fraudster registration job ended.

", - "FraudsterRegistrationJobSummary$CreatedAt": "

A timestamp showing when the fraudster registration job is created.

", - "FraudsterRegistrationJobSummary$EndedAt": "

A timestamp showing when the fraudster registration job ended.

", - "Speaker$CreatedAt": "

A timestamp showing when the speaker is created.

", - "Speaker$LastAccessedAt": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

", - "Speaker$UpdatedAt": "

A timestamp showing the speaker's last update.

", - "SpeakerEnrollmentJob$CreatedAt": "

A timestamp showing the creation of the speaker enrollment job.

", - "SpeakerEnrollmentJob$EndedAt": "

A timestamp showing when the speaker enrollment job ended.

", - "SpeakerEnrollmentJobSummary$CreatedAt": "

A timestamp showing the creation time of the speaker enrollment job.

", - "SpeakerEnrollmentJobSummary$EndedAt": "

A timestamp showing when the speaker enrollment job ended.

", + "AuthenticationResult$AudioAggregationEndedAt": "

A timestamp of when audio aggregation ended for this authentication result.

", + "AuthenticationResult$AudioAggregationStartedAt": "

A timestamp of when audio aggregation started for this authentication result.

", + "Domain$CreatedAt": "

The timestamp of when the domain was created.

", + "Domain$UpdatedAt": "

The timestamp of when the domain was last update.

", + "DomainSummary$CreatedAt": "

The timestamp of when the domain was created.

", + "DomainSummary$UpdatedAt": "

The timestamp of when the domain was last updated.

", + "FraudDetectionResult$AudioAggregationEndedAt": "

A timestamp of when audio aggregation ended for this fraud detection result.

", + "FraudDetectionResult$AudioAggregationStartedAt": "

A timestamp of when audio aggregation started for this fraud detection result.

", + "Fraudster$CreatedAt": "

The timestamp of when Voice ID identified the fraudster.

", + "FraudsterRegistrationJob$CreatedAt": "

A timestamp of when the fraudster registration job was created.

", + "FraudsterRegistrationJob$EndedAt": "

A timestamp of when the fraudster registration job ended.

", + "FraudsterRegistrationJobSummary$CreatedAt": "

A timestamp of when the fraudster registration job was created.

", + "FraudsterRegistrationJobSummary$EndedAt": "

A timestamp of when the fraudster registration job ended.

", + "FraudsterSummary$CreatedAt": "

The timestamp of when the fraudster summary was created.

", + "Speaker$CreatedAt": "

A timestamp of when the speaker was created.

", + "Speaker$LastAccessedAt": "

The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

", + "Speaker$UpdatedAt": "

A timestamp of the speaker's last update.

", + "SpeakerEnrollmentJob$CreatedAt": "

A timestamp of when the speaker enrollment job was created.

", + "SpeakerEnrollmentJob$EndedAt": "

A timestamp of when the speaker enrollment job ended.

", + "SpeakerEnrollmentJobSummary$CreatedAt": "

A timestamp of when of the speaker enrollment job was created.

", + "SpeakerEnrollmentJobSummary$EndedAt": "

A timestamp of when the speaker enrollment job ended.

", "SpeakerSummary$CreatedAt": "

A timestamp showing the speaker's creation time.

", "SpeakerSummary$LastAccessedAt": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

", - "SpeakerSummary$UpdatedAt": "

A timestamp showing the speaker's last update.

" + "SpeakerSummary$UpdatedAt": "

A timestamp showing the speaker's last update.

", + "Watchlist$CreatedAt": "

The timestamp of when the watchlist was created.

", + "Watchlist$UpdatedAt": "

The timestamp of when the watchlist was updated.

", + "WatchlistSummary$CreatedAt": "

The timestamp of when the watchlist was created.

", + "WatchlistSummary$UpdatedAt": "

The timestamp of when the watchlist was last updated.

" } }, "UniqueIdLarge": { @@ -839,6 +978,16 @@ "refs": { } }, + "UpdateWatchlistRequest": { + "base": null, + "refs": { + } + }, + "UpdateWatchlistResponse": { + "base": null, + "refs": { + } + }, "ValidationException": { "base": "

The request failed one or more validations; check the error message for more details.

", "refs": { @@ -849,6 +998,69 @@ "refs": { "FraudRiskDetails$VoiceSpoofingRisk": "

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

" } + }, + "Watchlist": { + "base": "

Contains all the information about a watchlist.

", + "refs": { + "CreateWatchlistResponse$Watchlist": "

Information about the newly created watchlist.

", + "DescribeWatchlistResponse$Watchlist": "

Information about the specified watchlist.

", + "UpdateWatchlistResponse$Watchlist": "

Details about the updated watchlist.

" + } + }, + "WatchlistDescription": { + "base": null, + "refs": { + "CreateWatchlistRequest$Description": "

A brief description of this watchlist.

", + "UpdateWatchlistRequest$Description": "

A brief description about this watchlist.

", + "Watchlist$Description": "

The description of the watchlist.

", + "WatchlistSummary$Description": "

The description of the watchlist.

" + } + }, + "WatchlistDetails": { + "base": "

Details of the watchlists in a domain.

", + "refs": { + "Domain$WatchlistDetails": "

The watchlist details of a domain. Contains the default watchlist ID of the domain.

", + "DomainSummary$WatchlistDetails": "

Provides information about watchlistDetails and DefaultWatchlistID.

" + } + }, + "WatchlistId": { + "base": null, + "refs": { + "AssociateFraudsterRequest$WatchlistId": "

The identifier of the watchlist you want to associate with the fraudster.

", + "DeleteWatchlistRequest$WatchlistId": "

The identifier of the watchlist to be deleted.

", + "DescribeWatchlistRequest$WatchlistId": "

The identifier of the watchlist that you are describing.

", + "DisassociateFraudsterRequest$WatchlistId": "

The identifier of the watchlist that you want to disassociate from the fraudster.

", + "EnrollmentJobFraudDetectionConfigWatchlistIds$member": null, + "FraudDetectionConfiguration$WatchlistId": "

The identifier of the watchlist against which fraud detection is performed.

", + "ListFraudstersRequest$WatchlistId": "

The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.

", + "RegistrationConfigWatchlistIds$member": null, + "ResponseWatchlistIds$member": null, + "UpdateWatchlistRequest$WatchlistId": "

The identifier of the watchlist to be updated.

", + "Watchlist$WatchlistId": "

The identifier of the watchlist.

", + "WatchlistDetails$DefaultWatchlistId": "

The identifier of the default watchlist.

", + "WatchlistSummary$WatchlistId": "

The identifier of the watchlist.

" + } + }, + "WatchlistName": { + "base": null, + "refs": { + "CreateWatchlistRequest$Name": "

The name of the watchlist.

", + "UpdateWatchlistRequest$Name": "

The name of the watchlist.

", + "Watchlist$Name": "

The name for the watchlist.

", + "WatchlistSummary$Name": "

The name for the watchlist.

" + } + }, + "WatchlistSummaries": { + "base": null, + "refs": { + "ListWatchlistsResponse$WatchlistSummaries": "

A list that contains details about each watchlist in the Amazon Web Services account.

" + } + }, + "WatchlistSummary": { + "base": "

Contains a summary of information about a watchlist.

", + "refs": { + "WatchlistSummaries$member": null + } } } } diff --git a/models/apis/voice-id/2021-09-27/endpoint-rule-set-1.json b/models/apis/voice-id/2021-09-27/endpoint-rule-set-1.json new file mode 100644 index 00000000000..4405db0b24e --- /dev/null +++ b/models/apis/voice-id/2021-09-27/endpoint-rule-set-1.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voiceid-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voiceid-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voiceid.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://voiceid.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/voice-id/2021-09-27/endpoint-tests-1.json b/models/apis/voice-id/2021-09-27/endpoint-tests-1.json new file mode 100644 index 00000000000..07cfaef5945 --- /dev/null +++ b/models/apis/voice-id/2021-09-27/endpoint-tests-1.json @@ -0,0 +1,392 @@ +{ + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://voiceid.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/voice-id/2021-09-27/paginators-1.json b/models/apis/voice-id/2021-09-27/paginators-1.json index 8c86dd440f0..fbb0f7a22b5 100644 --- a/models/apis/voice-id/2021-09-27/paginators-1.json +++ b/models/apis/voice-id/2021-09-27/paginators-1.json @@ -12,6 +12,12 @@ "limit_key": "MaxResults", "result_key": "JobSummaries" }, + "ListFraudsters": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "FraudsterSummaries" + }, "ListSpeakerEnrollmentJobs": { "input_token": "NextToken", "output_token": "NextToken", @@ -23,6 +29,12 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpeakerSummaries" + }, + "ListWatchlists": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "WatchlistSummaries" } } } diff --git a/service/appregistry/api.go b/service/appregistry/api.go index f5bba716924..c92fdb6363d 100644 --- a/service/appregistry/api.go +++ b/service/appregistry/api.go @@ -151,8 +151,8 @@ func (c *AppRegistry) AssociateResourceRequest(input *AssociateResourceInput) (r // AssociateResource API operation for AWS Service Catalog App Registry. // -// Associates a resource with an application. Both the resource and the application -// can be specified either by ID or name. +// Associates a resource with an application. The resource can be specified +// by its ARN or name. The application can be specified by ARN, ID, or name. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -179,6 +179,9 @@ func (c *AppRegistry) AssociateResourceRequest(input *AssociateResourceInput) (r // - ValidationException // The request has invalid or missing parameters. // +// - ThrottlingException +// The maximum number of API requests has been exceeded. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/AssociateResource func (c *AppRegistry) AssociateResource(input *AssociateResourceInput) (*AssociateResourceOutput, error) { req, out := c.AssociateResourceRequest(input) @@ -269,6 +272,9 @@ func (c *AppRegistry) CreateApplicationRequest(input *CreateApplicationInput) (r // - ValidationException // The request has invalid or missing parameters. // +// - ThrottlingException +// The maximum number of API requests has been exceeded. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/CreateApplication func (c *AppRegistry) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error) { req, out := c.CreateApplicationRequest(input) @@ -426,8 +432,8 @@ func (c *AppRegistry) DeleteApplicationRequest(input *DeleteApplicationInput) (r // DeleteApplication API operation for AWS Service Catalog App Registry. // -// Deletes an application that is specified either by its application ID or -// name. All associated attribute groups and resources must be disassociated +// Deletes an application that is specified either by its application ID, name, +// or ARN. All associated attribute groups and resources must be disassociated // from it before deleting an application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -513,8 +519,8 @@ func (c *AppRegistry) DeleteAttributeGroupRequest(input *DeleteAttributeGroupInp // DeleteAttributeGroup API operation for AWS Service Catalog App Registry. // -// Deletes an attribute group, specified either by its attribute group ID or -// name. +// Deletes an attribute group, specified either by its attribute group ID, name, +// or ARN. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -707,6 +713,9 @@ func (c *AppRegistry) DisassociateResourceRequest(input *DisassociateResourceInp // - ValidationException // The request has invalid or missing parameters. // +// - ThrottlingException +// The maximum number of API requests has been exceeded. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/DisassociateResource func (c *AppRegistry) DisassociateResource(input *DisassociateResourceInput) (*DisassociateResourceOutput, error) { req, out := c.DisassociateResourceRequest(input) @@ -773,11 +782,10 @@ func (c *AppRegistry) GetApplicationRequest(input *GetApplicationInput) (req *re // GetApplication API operation for AWS Service Catalog App Registry. // // Retrieves metadata information about one of your applications. The application -// can be specified either by its unique ID or by its name (which is unique -// within one account in one region at a given point in time). Specify by ID -// in automated workflows if you want to make sure that the exact same application -// is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing -// problem. +// can be specified by its ARN, ID, or name (which is unique within one account +// in one region at a given point in time). Specify by ARN or ID in automated +// workflows if you want to make sure that the exact same application is returned +// or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -951,8 +959,8 @@ func (c *AppRegistry) GetAttributeGroupRequest(input *GetAttributeGroupInput) (r // GetAttributeGroup API operation for AWS Service Catalog App Registry. // -// Retrieves an attribute group, either by its name or its ID. The attribute -// group can be specified either by its unique ID or by its name. +// Retrieves an attribute group by its ARN, ID, or name. The attribute group +// can be specified by its ARN, ID, or name. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2029,6 +2037,12 @@ func (c *AppRegistry) SyncResourceRequest(input *SyncResourceInput) (req *reques // There was a conflict when processing the request (for example, a resource // with the given name already exists within the account). // +// - ThrottlingException +// The maximum number of API requests has been exceeded. +// +// - ValidationException +// The request has invalid or missing parameters. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/SyncResource func (c *AppRegistry) SyncResource(input *SyncResourceInput) (*SyncResourceOutput, error) { req, out := c.SyncResourceRequest(input) @@ -2297,6 +2311,9 @@ func (c *AppRegistry) UpdateApplicationRequest(input *UpdateApplicationInput) (r // - InternalServerException // The service is experiencing internal problems. // +// - ThrottlingException +// The maximum number of API requests has been exceeded. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/UpdateApplication func (c *AppRegistry) UpdateApplication(input *UpdateApplicationInput) (*UpdateApplicationOutput, error) { req, out := c.UpdateApplicationRequest(input) @@ -2408,7 +2425,7 @@ func (c *AppRegistry) UpdateAttributeGroupWithContext(ctx aws.Context, input *Up return out, req.Send() } -// Includes all of the Service Catalog AppRegistry settings. +// Includes all of the AppRegistry settings. type AppRegistryConfiguration struct { _ struct{} `type:"structure"` @@ -2611,13 +2628,13 @@ func (s *ApplicationSummary) SetName(v string) *ApplicationSummary { type AssociateAttributeGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` - // The name or ID of the attribute group that holds the attributes to describe - // the application. + // The name, ID, or ARN of the attribute group that holds the attributes to + // describe the application. // // AttributeGroup is a required field AttributeGroup *string `location:"uri" locationName:"attributeGroup" min:"1" type:"string" required:"true"` @@ -2720,7 +2737,7 @@ func (s *AssociateAttributeGroupOutput) SetAttributeGroupArn(v string) *Associat type AssociateResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -2857,7 +2874,7 @@ type AttributeGroup struct { Description *string `locationName:"description" type:"string"` // The globally unique attribute group identifier of the attribute group. - Id *string `locationName:"id" min:"26" type:"string"` + Id *string `locationName:"id" min:"1" type:"string"` // The ISO-8601 formatted timestamp of the moment the attribute group was last // updated. This time is the same as the creationTime for a newly created attribute @@ -2938,8 +2955,11 @@ type AttributeGroupDetails struct { // The Amazon resource name (ARN) that specifies the attribute group. Arn *string `locationName:"arn" type:"string"` + // The service principal that created the attribute group. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + // The unique identifier of the attribute group. - Id *string `locationName:"id" min:"26" type:"string"` + Id *string `locationName:"id" min:"1" type:"string"` // // This field is no longer supported. We recommend you don't use the field when @@ -2975,6 +2995,12 @@ func (s *AttributeGroupDetails) SetArn(v string) *AttributeGroupDetails { return s } +// SetCreatedBy sets the CreatedBy field's value. +func (s *AttributeGroupDetails) SetCreatedBy(v string) *AttributeGroupDetails { + s.CreatedBy = &v + return s +} + // SetId sets the Id field's value. func (s *AttributeGroupDetails) SetId(v string) *AttributeGroupDetails { s.Id = &v @@ -2995,6 +3021,9 @@ type AttributeGroupSummary struct { // services. Arn *string `locationName:"arn" type:"string"` + // The service principal that created the attribute group. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + // The ISO-8601 formatted timestamp of the moment the attribute group was created. CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` @@ -3002,7 +3031,7 @@ type AttributeGroupSummary struct { Description *string `locationName:"description" type:"string"` // The globally unique attribute group identifier of the attribute group. - Id *string `locationName:"id" min:"26" type:"string"` + Id *string `locationName:"id" min:"1" type:"string"` // The ISO-8601 formatted timestamp of the moment the attribute group was last // updated. This time is the same as the creationTime for a newly created attribute @@ -3037,6 +3066,12 @@ func (s *AttributeGroupSummary) SetArn(v string) *AttributeGroupSummary { return s } +// SetCreatedBy sets the CreatedBy field's value. +func (s *AttributeGroupSummary) SetCreatedBy(v string) *AttributeGroupSummary { + s.CreatedBy = &v + return s +} + // SetCreationTime sets the CreationTime field's value. func (s *AttributeGroupSummary) SetCreationTime(v time.Time) *AttributeGroupSummary { s.CreationTime = &v @@ -3382,7 +3417,7 @@ func (s *CreateAttributeGroupOutput) SetAttributeGroup(v *AttributeGroup) *Creat type DeleteApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -3462,8 +3497,8 @@ func (s *DeleteApplicationOutput) SetApplication(v *ApplicationSummary) *DeleteA type DeleteAttributeGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the attribute group that holds the attributes to describe - // the application. + // The name, ID, or ARN of the attribute group that holds the attributes to + // describe the application. // // AttributeGroup is a required field AttributeGroup *string `location:"uri" locationName:"attributeGroup" min:"1" type:"string" required:"true"` @@ -3543,13 +3578,13 @@ func (s *DeleteAttributeGroupOutput) SetAttributeGroup(v *AttributeGroupSummary) type DisassociateAttributeGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` - // The name or ID of the attribute group that holds the attributes to describe - // the application. + // The name, ID, or ARN of the attribute group that holds the attributes to + // describe the application. // // AttributeGroup is a required field AttributeGroup *string `location:"uri" locationName:"attributeGroup" min:"1" type:"string" required:"true"` @@ -3773,7 +3808,7 @@ func (s *DisassociateResourceOutput) SetResourceArn(v string) *DisassociateResou type GetApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -3928,7 +3963,7 @@ func (s *GetApplicationOutput) SetTags(v map[string]*string) *GetApplicationOutp type GetAssociatedResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -4042,8 +4077,8 @@ func (s *GetAssociatedResourceOutput) SetResource(v *Resource) *GetAssociatedRes type GetAttributeGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the attribute group that holds the attributes to describe - // the application. + // The name, ID, or ARN of the attribute group that holds the attributes to + // describe the application. // // AttributeGroup is a required field AttributeGroup *string `location:"uri" locationName:"attributeGroup" min:"1" type:"string" required:"true"` @@ -4100,6 +4135,9 @@ type GetAttributeGroupOutput struct { // in the group and describes an application and its components. Attributes *string `locationName:"attributes" min:"1" type:"string"` + // The service principal that created the attribute group. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + // The ISO-8601 formatted timestamp of the moment the attribute group was created. CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` @@ -4107,7 +4145,7 @@ type GetAttributeGroupOutput struct { Description *string `locationName:"description" type:"string"` // The identifier of the attribute group. - Id *string `locationName:"id" min:"26" type:"string"` + Id *string `locationName:"id" min:"1" type:"string"` // The ISO-8601 formatted timestamp of the moment the attribute group was last // updated. This time is the same as the creationTime for a newly created attribute @@ -4151,6 +4189,12 @@ func (s *GetAttributeGroupOutput) SetAttributes(v string) *GetAttributeGroupOutp return s } +// SetCreatedBy sets the CreatedBy field's value. +func (s *GetAttributeGroupOutput) SetCreatedBy(v string) *GetAttributeGroupOutput { + s.CreatedBy = &v + return s +} + // SetCreationTime sets the CreationTime field's value. func (s *GetAttributeGroupOutput) SetCreationTime(v time.Time) *GetAttributeGroupOutput { s.CreationTime = &v @@ -4550,7 +4594,7 @@ func (s *ListAssociatedAttributeGroupsOutput) SetNextToken(v string) *ListAssoci type ListAssociatedResourcesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name or ID of the application. + // The name, ID, or ARN of the application. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -5629,6 +5673,74 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// The maximum number of API requests has been exceeded. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // A message associated with the Throttling exception. + Message_ *string `locationName:"message" type:"string"` + + // The originating service code. + ServiceCode *string `locationName:"serviceCode" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + type UntagResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -5717,7 +5829,7 @@ func (s UntagResourceOutput) GoString() string { type UpdateApplicationInput struct { _ struct{} `type:"structure"` - // The name or ID of the application that will be updated. + // The name, ID, or ARN of the application that will be updated. // // Application is a required field Application *string `location:"uri" locationName:"application" min:"1" type:"string" required:"true"` @@ -5822,8 +5934,8 @@ func (s *UpdateApplicationOutput) SetApplication(v *Application) *UpdateApplicat type UpdateAttributeGroupInput struct { _ struct{} `type:"structure"` - // The name or ID of the attribute group that holds the attributes to describe - // the application. + // The name, ID, or ARN of the attribute group that holds the attributes to + // describe the application. // // AttributeGroup is a required field AttributeGroup *string `location:"uri" locationName:"attributeGroup" min:"1" type:"string" required:"true"` diff --git a/service/appregistry/errors.go b/service/appregistry/errors.go index 03829bfa502..29799ece193 100644 --- a/service/appregistry/errors.go +++ b/service/appregistry/errors.go @@ -33,6 +33,12 @@ const ( // The maximum number of resources per account has been reached. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // The maximum number of API requests has been exceeded. + ErrCodeThrottlingException = "ThrottlingException" + // ErrCodeValidationException for service response error code // "ValidationException". // @@ -45,5 +51,6 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "InternalServerException": newErrorInternalServerException, "ResourceNotFoundException": newErrorResourceNotFoundException, "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, "ValidationException": newErrorValidationException, } diff --git a/service/athena/api.go b/service/athena/api.go index 688f378554e..43cfaf9472b 100644 --- a/service/athena/api.go +++ b/service/athena/api.go @@ -676,7 +676,8 @@ func (c *Athena) CreatePresignedNotebookUrlRequest(input *CreatePresignedNoteboo // // Gets an authentication token and the URL at which the notebook can be accessed. // During programmatic access, CreatePresignedNotebookUrl must be called every -// 10 minutes to refresh the authentication token. +// 10 minutes to refresh the authentication token. For information about granting +// programmatic access, see Grant programmatic access (https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -764,10 +765,8 @@ func (c *Athena) CreateWorkGroupRequest(input *CreateWorkGroupInput) (req *reque // CreateWorkGroup API operation for Amazon Athena. // -// Creates a workgroup with the specified name. Only one of Configurations or -// Configuration can be specified; Configurations for a workgroup with multi -// engine support (for example, an Apache Spark enabled workgroup) or Configuration -// for an Athena SQL workgroup. +// Creates a workgroup with the specified name. A workgroup can be an Apache +// Spark enabled workgroup or an Athena SQL workgroup. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1463,8 +1462,7 @@ func (c *Athena) GetCalculationExecutionCodeRequest(input *GetCalculationExecuti // GetCalculationExecutionCode API operation for Amazon Athena. // -// Retrieves a pre-signed URL to a copy of the code that was executed for the -// calculation. +// Retrieves the unencrypted code that was executed for the calculation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2167,7 +2165,7 @@ func (c *Athena) GetQueryResultsRequest(input *GetQueryResultsInput) (req *reque // // Streams the results of a single query execution specified by QueryExecutionId // from the Athena query results location in Amazon S3. For more information, -// see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html) +// see Working with query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html) // in the Amazon Athena User Guide. This request does not execute the query // but returns results. Use StartQueryExecution to run a query. // @@ -2852,7 +2850,7 @@ func (c *Athena) ListApplicationDPUSizesRequest(input *ListApplicationDPUSizesIn // ListApplicationDPUSizes API operation for Amazon Athena. // // Returns the supported DPU sizes for the supported application runtimes (for -// example, Jupyter 1.0). +// example, Athena notebook version 1). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3576,9 +3574,9 @@ func (c *Athena) ListExecutorsRequest(input *ListExecutorsInput) (req *request.R // ListExecutors API operation for Amazon Athena. // -// Lists, in descending order, the executors that have been submitted to a session. -// Newer executors are listed first; older executors are listed later. The result -// can be optionally filtered by state. +// Lists, in descending order, the executors that joined a session. Newer executors +// are listed first; older executors are listed later. The result can be optionally +// filtered by state. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4908,7 +4906,7 @@ func (c *Athena) StartCalculationExecutionRequest(input *StartCalculationExecuti // StartCalculationExecution API operation for Amazon Athena. // // Submits calculations for execution within a session. You can supply the code -// to run as an inline code block within the request or as an Amazon S3 URL. +// to run as an inline code block within the request. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5372,7 +5370,7 @@ func (c *Athena) TagResourceRequest(input *TagResourceInput) (req *request.Reque // For example, you can use tags to categorize Athena workgroups or data catalogs // by purpose, owner, or environment. Use a consistent set of tag keys to make // it easier to search and filter workgroups or data catalogs in your account. -// For best practices, see Tagging Best Practices (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). +// For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). // Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can // be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers // representable in UTF-8, and the following characters: + - = . _ : / @. Tag @@ -6078,10 +6076,7 @@ func (c *Athena) UpdateWorkGroupRequest(input *UpdateWorkGroupInput) (req *reque // UpdateWorkGroup API operation for Amazon Athena. // // Updates the workgroup with the specified name. The workgroup's name cannot -// be changed. Only one of ConfigurationsUpdates or ConfigurationUpdates can -// be specified; ConfigurationsUpdates for a workgroup with multi engine support -// (for example, an Apache Spark enabled workgroup) or ConfigurationUpdates -// for an Athena SQL workgroup. +// be changed. Only ConfigurationUpdates can be specified. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6183,7 +6178,8 @@ func (s *AclConfiguration) SetS3AclOption(v string) *AclConfiguration { type ApplicationDPUSizes struct { _ struct{} `type:"structure"` - // The name of the supported application runtime (for example, Jupyter 1.0). + // The name of the supported application runtime (for example, Athena notebook + // version 1). ApplicationRuntimeId *string `min:"1" type:"string"` // A list of the supported DPU sizes that the application runtime supports. @@ -7645,8 +7641,9 @@ func (s *CreatePresignedNotebookUrlOutput) SetNotebookUrl(v string) *CreatePresi type CreateWorkGroupInput struct { _ struct{} `type:"structure"` - // Contains configuration information for creating an Athena SQL workgroup, - // which includes the location in Amazon S3 where query results are stored, + // Contains configuration information for creating an Athena SQL workgroup or + // Spark enabled Athena workgroup. Athena SQL workgroup configuration includes + // the location in Amazon S3 where query and calculation results are stored, // the encryption configuration, if any, used for encrypting query results, // whether the Amazon CloudWatch Metrics are enabled for the workgroup, the // limit for the amount of bytes scanned (cutoff) per query, if it is specified, @@ -8324,7 +8321,7 @@ type DeleteWorkGroupInput struct { _ struct{} `type:"structure"` // The option to delete the workgroup and its contents even if the workgroup - // contains any named queries or query executions. + // contains any named queries, query executions, or notebooks. RecursiveDeleteOption *bool `type:"boolean"` // The unique name of the workgroup to delete. @@ -8398,8 +8395,8 @@ func (s DeleteWorkGroupOutput) GoString() string { return s.String() } -// If query results are encrypted in Amazon S3, indicates the encryption option -// used (for example, SSE_KMS or CSE_KMS) and key information. +// If query and calculation results are encrypted in Amazon S3, indicates the +// encryption option used (for example, SSE_KMS or CSE_KMS) and key information. type EncryptionConfiguration struct { _ struct{} `type:"structure"` @@ -8467,10 +8464,10 @@ type EngineConfiguration struct { _ struct{} `type:"structure"` // Contains additional notebook engine MAP parameter mappings - // in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter + // in the form of key-value pairs. To specify an Athena notebook that the Jupyter // server will download and serve, specify a value for the StartSessionRequest$NotebookVersion - // field, and then add a key named NotebookFileURI to AdditionalConfigs that - // has value of the Amazon S3 URI. + // field, and then add a key named NotebookId to AdditionalConfigs that has + // the value of the Athena notebook ID. AdditionalConfigs map[string]*string `type:"map"` // The number of DPUs to use for the coordinator. A coordinator is a special @@ -8896,7 +8893,7 @@ func (s *GetCalculationExecutionCodeInput) SetCalculationExecutionId(v string) * type GetCalculationExecutionCodeOutput struct { _ struct{} `type:"structure"` - // A pre-signed URL to the code that executed the calculation. + // The unencrypted code that was executed for the calculation. CodeBlock *string `type:"string"` } @@ -10417,7 +10414,7 @@ func (s *ImportNotebookInput) SetWorkGroup(v string) *ImportNotebookInput { type ImportNotebookOutput struct { _ struct{} `type:"structure"` - // The ID of the notebook to import. + // The ID assigned to the imported notebook. NotebookId *string `min:"1" type:"string"` } @@ -12778,11 +12775,11 @@ type QueryExecution struct { // The unique identifier for each query execution. QueryExecutionId *string `min:"1" type:"string"` - // The location in Amazon S3 where query results were stored and the encryption - // option, if any, used for query results. These are known as "client-side settings". - // If workgroup settings override client-side settings, then the query uses - // the location for the query results and the encryption configuration that - // are specified for the workgroup. + // The location in Amazon S3 where query and calculation results are stored + // and the encryption option, if any, used for query results. These are known + // as "client-side settings". If workgroup settings override client-side settings, + // then the query uses the location for the query results and the encryption + // configuration that are specified for the workgroup. ResultConfiguration *ResultConfiguration `type:"structure"` // Specifies the query result reuse behavior that was used for the query. @@ -13570,10 +13567,10 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// The location in Amazon S3 where query results are stored and the encryption -// option, if any, used for query results. These are known as "client-side settings". -// If workgroup settings override client-side settings, then the query uses -// the workgroup settings. +// The location in Amazon S3 where query and calculation results are stored +// and the encryption option, if any, used for query and calculation results. +// These are known as "client-side settings". If workgroup settings override +// client-side settings, then the query uses the workgroup settings. type ResultConfiguration struct { _ struct{} `type:"structure"` @@ -13586,13 +13583,13 @@ type ResultConfiguration struct { // and Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). AclConfiguration *AclConfiguration `type:"structure"` - // If query results are encrypted in Amazon S3, indicates the encryption option - // used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side - // setting. If workgroup settings override client-side settings, then the query - // uses the encryption configuration that is specified for the workgroup, and - // also uses the location for storing query results specified in the workgroup. - // See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings - // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // If query and calculation results are encrypted in Amazon S3, indicates the + // encryption option used (for example, SSE_KMS or CSE_KMS) and key information. + // This is a client-side setting. If workgroup settings override client-side + // settings, then the query uses the encryption configuration that is specified + // for the workgroup, and also uses the location for storing query results specified + // in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration + // and Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // The Amazon Web Services account ID that you expect to be the owner of the @@ -13609,12 +13606,13 @@ type ResultConfiguration struct { // and Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). ExpectedBucketOwner *string `min:"12" type:"string"` - // The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. - // To run the query, you must specify the query results location using one of - // the ways: either for individual queries using either this setting (client-side), - // or in the workgroup, using WorkGroupConfiguration. If none of them is set, - // Athena issues an error that no output location is provided. For more information, - // see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html). + // The location in Amazon S3 where your query and calculation results are stored, + // such as s3://path/to/query/bucket/. To run the query, you must specify the + // query results location using one of the ways: either for individual queries + // using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. + // If none of them is set, Athena issues an error that no output location is + // provided. For more information, see Working with query results, recent queries, + // and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html). // If workgroup settings override client-side settings, then the query uses // the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. OutputLocation *string `type:"string"` @@ -13693,7 +13691,7 @@ type ResultConfigurationUpdates struct { // The ACL configuration for the query results. AclConfiguration *AclConfiguration `type:"structure"` - // The encryption configuration for the query results. + // The encryption configuration for query and calculation results. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // The Amazon Web Services account ID that you expect to be the owner of the @@ -13710,8 +13708,9 @@ type ResultConfigurationUpdates struct { // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). ExpectedBucketOwner *string `min:"12" type:"string"` - // The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. - // For more information, see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html) + // The location in Amazon S3 where your query and calculation results are stored, + // such as s3://path/to/query/bucket/. For more information, see Working with + // query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html). // If workgroup settings override client-side settings, then the query uses // the location for the query results and the encryption configuration that // are specified for the workgroup. The "workgroup settings override" is specified @@ -14161,8 +14160,8 @@ func (s *SessionAlreadyExistsException) RequestID() string { type SessionConfiguration struct { _ struct{} `type:"structure"` - // If query results are encrypted in Amazon S3, indicates the encryption option - // used (for example, SSE_KMS or CSE_KMS) and key information. + // If query and calculation results are encrypted in Amazon S3, indicates the + // encryption option used (for example, SSE_KMS or CSE_KMS) and key information. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // The ARN of the execution role used for the session. @@ -14217,7 +14216,7 @@ func (s *SessionConfiguration) SetWorkingDirectory(v string) *SessionConfigurati return s } -// Contains statistics for a notebook session. +// Contains statistics for a session. type SessionStatistics struct { _ struct{} `type:"structure"` @@ -14249,7 +14248,7 @@ func (s *SessionStatistics) SetDpuExecutionInMillis(v int64) *SessionStatistics return s } -// Contains information about the status of a notebook session. +// Contains information about the status of a session. type SessionStatus struct { _ struct{} `type:"structure"` @@ -14344,7 +14343,7 @@ func (s *SessionStatus) SetStateChangeReason(v string) *SessionStatus { return s } -// Contains summary information about a notebook session. +// Contains summary information about a session. type SessionSummary struct { _ struct{} `type:"structure"` @@ -14761,9 +14760,11 @@ type StartSessionInput struct { // EngineConfiguration is a required field EngineConfiguration *EngineConfiguration `type:"structure" required:"true"` - // The notebook version. This value is required only when requesting that a - // notebook server be started for the session. The only valid notebook version - // is Jupyter1.0. + // The notebook version. This value is supplied automatically for notebook sessions + // in the Athena console and is not required for programmatic session access. + // The only valid notebook version is Athena notebook version 1. If you specify + // a value for NotebookVersion, you must also specify a value for NotebookId. + // See EngineConfiguration$AdditionalConfigs. NotebookVersion *string `min:"1" type:"string"` // The idle timeout in minutes for the session. @@ -15173,7 +15174,7 @@ func (s *TableMetadata) SetTableType(v string) *TableMetadata { // which you define. For example, you can use tags to categorize Athena workgroups // or data catalogs by purpose, owner, or environment. Use a consistent set // of tag keys to make it easier to search and filter workgroups or data catalogs -// in your account. For best practices, see Tagging Best Practices (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). +// in your account. For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). // Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can // be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers // representable in UTF-8, and the following characters: + - = . _ : / @. Tag @@ -16005,7 +16006,7 @@ type UpdateNotebookInput struct { // Payload is a required field Payload *string `min:"1" type:"string" required:"true"` - // The ID of the session in which the notebook will be updated. + // The active notebook session ID. Required if the notebook has an active session. SessionId *string `min:"1" type:"string"` // The notebook content type. Currently, the only valid type is IPYNB. @@ -16448,12 +16449,13 @@ type WorkGroup struct { _ struct{} `type:"structure"` // The configuration of the workgroup, which includes the location in Amazon - // S3 where query results are stored, the encryption configuration, if any, - // used for query results; whether the Amazon CloudWatch Metrics are enabled - // for the workgroup; whether workgroup settings override client-side settings; - // and the data usage limits for the amount of data scanned per query or per - // workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration - // (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // S3 where query and calculation results are stored, the encryption configuration, + // if any, used for query and calculation results; whether the Amazon CloudWatch + // Metrics are enabled for the workgroup; whether workgroup settings override + // client-side settings; and the data usage limits for the amount of data scanned + // per query or per workgroup. The workgroup settings override is specified + // in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. + // See WorkGroupConfiguration$EnforceWorkGroupConfiguration. Configuration *WorkGroupConfiguration `type:"structure"` // The date and time the workgroup was created. @@ -16520,12 +16522,13 @@ func (s *WorkGroup) SetState(v string) *WorkGroup { } // The configuration of the workgroup, which includes the location in Amazon -// S3 where query results are stored, the encryption option, if any, used for -// query results, whether the Amazon CloudWatch Metrics are enabled for the -// workgroup and whether workgroup settings override query settings, and the -// data usage limits for the amount of data scanned per query or per workgroup. -// The workgroup settings override is specified in EnforceWorkGroupConfiguration -// (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. +// S3 where query and calculation results are stored, the encryption option, +// if any, used for query and calculation results, whether the Amazon CloudWatch +// Metrics are enabled for the workgroup and whether workgroup settings override +// query settings, and the data usage limits for the amount of data scanned +// per query or per workgroup. The workgroup settings override is specified +// in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. +// See WorkGroupConfiguration$EnforceWorkGroupConfiguration. type WorkGroupConfiguration struct { _ struct{} `type:"structure"` @@ -16539,6 +16542,16 @@ type WorkGroupConfiguration struct { // Specifies the KMS key that is used to encrypt the user's data stores in Athena. CustomerContentEncryptionConfiguration *CustomerContentEncryptionConfiguration `type:"structure"` + // Enforces a minimal level of encryption for the workgroup for query and calculation + // results that are written to Amazon S3. When enabled, workgroup users can + // set encryption only to the minimum level set by the administrator or higher + // when they submit queries. + // + // The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration + // flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration + // flag is ignored, and the workgroup configuration for encryption is used. + EnableMinimumEncryptionConfiguration *bool `type:"boolean"` + // If set to "true", the settings for the workgroup override client-side settings. // If set to "false", client-side settings are used. For more information, see // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). @@ -16549,7 +16562,7 @@ type WorkGroupConfiguration struct { // regardless of this setting. EngineVersion *EngineVersion `type:"structure"` - // Role used in a notebook session for accessing the user's resources. + // Role used in a session for accessing the user's resources. ExecutionRole *string `min:"20" type:"string"` // Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. @@ -16565,12 +16578,13 @@ type WorkGroupConfiguration struct { RequesterPaysEnabled *bool `type:"boolean"` // The configuration for the workgroup, which includes the location in Amazon - // S3 where query results are stored and the encryption option, if any, used - // for query results. To run the query, you must specify the query results location - // using one of the ways: either in the workgroup using this setting, or for - // individual queries (client-side), using ResultConfiguration$OutputLocation. + // S3 where query and calculation results are stored and the encryption option, + // if any, used for query and calculation results. To run the query, you must + // specify the query results location using one of the ways: either in the workgroup + // using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. // If none of them is set, Athena issues an error that no output location is - // provided. For more information, see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html). + // provided. For more information, see Working with query results, recent queries, + // and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html). ResultConfiguration *ResultConfiguration `type:"structure"` } @@ -16644,6 +16658,12 @@ func (s *WorkGroupConfiguration) SetCustomerContentEncryptionConfiguration(v *Cu return s } +// SetEnableMinimumEncryptionConfiguration sets the EnableMinimumEncryptionConfiguration field's value. +func (s *WorkGroupConfiguration) SetEnableMinimumEncryptionConfiguration(v bool) *WorkGroupConfiguration { + s.EnableMinimumEncryptionConfiguration = &v + return s +} + // SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value. func (s *WorkGroupConfiguration) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfiguration { s.EnforceWorkGroupConfiguration = &v @@ -16681,11 +16701,11 @@ func (s *WorkGroupConfiguration) SetResultConfiguration(v *ResultConfiguration) } // The configuration information that will be updated for this workgroup, which -// includes the location in Amazon S3 where query results are stored, the encryption -// option, if any, used for query results, whether the Amazon CloudWatch Metrics -// are enabled for the workgroup, whether the workgroup settings override the -// client-side settings, and the data usage limit for the amount of bytes scanned -// per query, if it is specified. +// includes the location in Amazon S3 where query and calculation results are +// stored, the encryption option, if any, used for query results, whether the +// Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup +// settings override the client-side settings, and the data usage limit for +// the amount of bytes scanned per query, if it is specified. type WorkGroupConfigurationUpdates struct { _ struct{} `type:"structure"` @@ -16699,6 +16719,16 @@ type WorkGroupConfigurationUpdates struct { // Specifies the KMS key that is used to encrypt the user's data stores in Athena. CustomerContentEncryptionConfiguration *CustomerContentEncryptionConfiguration `type:"structure"` + // Enforces a minimal level of encryption for the workgroup for query and calculation + // results that are written to Amazon S3. When enabled, workgroup users can + // set encryption only to the minimum level set by the administrator or higher + // when they submit queries. This setting does not apply to Spark-enabled workgroups. + // + // The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration + // flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration + // flag is ignored, and the workgroup configuration for encryption is used. + EnableMinimumEncryptionConfiguration *bool `type:"boolean"` + // If set to "true", the settings for the workgroup override client-side settings. // If set to "false" client-side settings are used. For more information, see // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). @@ -16807,6 +16837,12 @@ func (s *WorkGroupConfigurationUpdates) SetCustomerContentEncryptionConfiguratio return s } +// SetEnableMinimumEncryptionConfiguration sets the EnableMinimumEncryptionConfiguration field's value. +func (s *WorkGroupConfigurationUpdates) SetEnableMinimumEncryptionConfiguration(v bool) *WorkGroupConfigurationUpdates { + s.EnableMinimumEncryptionConfiguration = &v + return s +} + // SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value. func (s *WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfigurationUpdates { s.EnforceWorkGroupConfiguration = &v diff --git a/service/chimesdkvoice/api.go b/service/chimesdkvoice/api.go index 6b61efa43a4..7aff04f71ee 100644 --- a/service/chimesdkvoice/api.go +++ b/service/chimesdkvoice/api.go @@ -56,6 +56,8 @@ func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnectorRequest(input *As // AssociatePhoneNumbersWithVoiceConnector API operation for Amazon Chime SDK Voice. // +// Associates phone numbers with the specified Amazon Chime SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -66,20 +68,28 @@ func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnectorRequest(input *As // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnector(input *AssociatePhoneNumbersWithVoiceConnectorInput) (*AssociatePhoneNumbersWithVoiceConnectorOutput, error) { @@ -146,6 +156,9 @@ func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnectorGroupRequest(inpu // AssociatePhoneNumbersWithVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Associates phone numbers with the specified Amazon Chime SDK Voice Connector +// group. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -156,20 +169,28 @@ func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnectorGroupRequest(inpu // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup func (c *ChimeSDKVoice) AssociatePhoneNumbersWithVoiceConnectorGroup(input *AssociatePhoneNumbersWithVoiceConnectorGroupInput) (*AssociatePhoneNumbersWithVoiceConnectorGroupOutput, error) { @@ -236,6 +257,12 @@ func (c *ChimeSDKVoice) BatchDeletePhoneNumberRequest(input *BatchDeletePhoneNum // BatchDeletePhoneNumber API operation for Amazon Chime SDK Voice. // +// Moves phone numbers into the Deletion queue. Phone numbers must be disassociated +// from any users or Amazon Chime SDK Voice Connectors before they can be deleted. +// +// Phone numbers remain in the Deletion queue for 7 days before they are deleted +// permanently. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -246,18 +273,25 @@ func (c *ChimeSDKVoice) BatchDeletePhoneNumberRequest(input *BatchDeletePhoneNum // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber func (c *ChimeSDKVoice) BatchDeletePhoneNumber(input *BatchDeletePhoneNumberInput) (*BatchDeletePhoneNumberOutput, error) { @@ -324,6 +358,8 @@ func (c *ChimeSDKVoice) BatchUpdatePhoneNumberRequest(input *BatchUpdatePhoneNum // BatchUpdatePhoneNumber API operation for Amazon Chime SDK Voice. // +// Updates one or more phone numbers. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -334,18 +370,25 @@ func (c *ChimeSDKVoice) BatchUpdatePhoneNumberRequest(input *BatchUpdatePhoneNum // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber func (c *ChimeSDKVoice) BatchUpdatePhoneNumber(input *BatchUpdatePhoneNumberInput) (*BatchUpdatePhoneNumberOutput, error) { @@ -412,6 +455,10 @@ func (c *ChimeSDKVoice) CreatePhoneNumberOrderRequest(input *CreatePhoneNumberOr // CreatePhoneNumberOrder API operation for Amazon Chime SDK Voice. // +// Creates an order for phone numbers to be provisioned. For numbers outside +// the U.S., you must use the Amazon Chime SDK SIP media application dial-in +// product type. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -422,20 +469,28 @@ func (c *ChimeSDKVoice) CreatePhoneNumberOrderRequest(input *CreatePhoneNumberOr // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder func (c *ChimeSDKVoice) CreatePhoneNumberOrder(input *CreatePhoneNumberOrderInput) (*CreatePhoneNumberOrderOutput, error) { @@ -502,6 +557,9 @@ func (c *ChimeSDKVoice) CreateProxySessionRequest(input *CreateProxySessionInput // CreateProxySession API operation for Amazon Chime SDK Voice. // +// Creates a proxy session for the specified Amazon Chime SDK Voice Connector +// for the specified participant phone numbers. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -512,18 +570,25 @@ func (c *ChimeSDKVoice) CreateProxySessionRequest(input *CreateProxySessionInput // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySession func (c *ChimeSDKVoice) CreateProxySession(input *CreateProxySessionInput) (*CreateProxySessionOutput, error) { @@ -590,6 +655,10 @@ func (c *ChimeSDKVoice) CreateSipMediaApplicationRequest(input *CreateSipMediaAp // CreateSipMediaApplication API operation for Amazon Chime SDK Voice. // +// Creates a SIP media application. For more information about SIP media applications, +// see Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) +// in the Amazon Chime SDK Administrator Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -600,22 +669,31 @@ func (c *ChimeSDKVoice) CreateSipMediaApplicationRequest(input *CreateSipMediaAp // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplication func (c *ChimeSDKVoice) CreateSipMediaApplication(input *CreateSipMediaApplicationInput) (*CreateSipMediaApplicationOutput, error) { @@ -682,6 +760,9 @@ func (c *ChimeSDKVoice) CreateSipMediaApplicationCallRequest(input *CreateSipMed // CreateSipMediaApplicationCall API operation for Amazon Chime SDK Voice. // +// Creates an outbound call to a phone number from the phone number specified +// in the request, and it invokes the endpoint of the specified sipMediaApplicationId. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -692,20 +773,28 @@ func (c *ChimeSDKVoice) CreateSipMediaApplicationCallRequest(input *CreateSipMed // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall func (c *ChimeSDKVoice) CreateSipMediaApplicationCall(input *CreateSipMediaApplicationCallInput) (*CreateSipMediaApplicationCallOutput, error) { @@ -772,6 +861,11 @@ func (c *ChimeSDKVoice) CreateSipRuleRequest(input *CreateSipRuleInput) (req *re // CreateSipRule API operation for Amazon Chime SDK Voice. // +// Creates a SIP rule, which can be used to run a SIP media application as a +// target for a specific trigger type. For more information about SIP rules, +// see Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) +// in the Amazon Chime SDK Administrator Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -782,22 +876,31 @@ func (c *ChimeSDKVoice) CreateSipRuleRequest(input *CreateSipRuleInput) (req *re // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRule func (c *ChimeSDKVoice) CreateSipRule(input *CreateSipRuleInput) (*CreateSipRuleOutput, error) { @@ -864,6 +967,10 @@ func (c *ChimeSDKVoice) CreateVoiceConnectorRequest(input *CreateVoiceConnectorI // CreateVoiceConnector API operation for Amazon Chime SDK Voice. // +// Creates an Amazon Chime SDK Voice Connector. For more information about Voice +// Connectors, see Managing Amazon Chime SDK Voice Connector groups (https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html) +// in the Amazon Chime SDK Administrator Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -874,20 +981,28 @@ func (c *ChimeSDKVoice) CreateVoiceConnectorRequest(input *CreateVoiceConnectorI // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnector func (c *ChimeSDKVoice) CreateVoiceConnector(input *CreateVoiceConnectorInput) (*CreateVoiceConnectorOutput, error) { @@ -954,6 +1069,14 @@ func (c *ChimeSDKVoice) CreateVoiceConnectorGroupRequest(input *CreateVoiceConne // CreateVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Creates an Amazon Chime SDK Voice Connector group under the administrator's +// AWS account. You can associate Amazon Chime SDK Voice Connectors with the +// Voice Connector group by including VoiceConnectorItems in the request. +// +// You can include Voice Connectors from different AWS Regions in your group. +// This creates a fault tolerant mechanism for fallback in case of availability +// events. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -964,20 +1087,28 @@ func (c *ChimeSDKVoice) CreateVoiceConnectorGroupRequest(input *CreateVoiceConne // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup func (c *ChimeSDKVoice) CreateVoiceConnectorGroup(input *CreateVoiceConnectorGroupInput) (*CreateVoiceConnectorGroupOutput, error) { @@ -1044,6 +1175,18 @@ func (c *ChimeSDKVoice) CreateVoiceProfileRequest(input *CreateVoiceProfileInput // CreateVoiceProfile API operation for Amazon Chime SDK Voice. // +// Creates a voice profile, which consists of an enrolled user and their latest +// voice print. +// +// Before creating any voice profiles, you must provide all notices and obtain +// all consents from the speaker as required under applicable privacy and biometrics +// laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) +// for the Amazon Chime SDK. +// +// For more information about voice profiles and voice analytics, see Using +// Amazon Chime SDK Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1054,26 +1197,38 @@ func (c *ChimeSDKVoice) CreateVoiceProfileRequest(input *CreateVoiceProfileInput // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - GoneException +// Access to the target resource is no longer available at the origin server. +// This condition is likely to be permanent. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfile func (c *ChimeSDKVoice) CreateVoiceProfile(input *CreateVoiceProfileInput) (*CreateVoiceProfileOutput, error) { @@ -1140,6 +1295,18 @@ func (c *ChimeSDKVoice) CreateVoiceProfileDomainRequest(input *CreateVoiceProfil // CreateVoiceProfileDomain API operation for Amazon Chime SDK Voice. // +// Creates a voice profile domain, a collection of voice profiles, their voice +// prints, and encrypted enrollment audio. +// +// Before creating any voice profiles, you must provide all notices and obtain +// all consents from the speaker as required under applicable privacy and biometrics +// laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) +// for the Amazon Chime SDK. +// +// For more information about voice profile domains, see Using Amazon Chime +// SDK Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1150,22 +1317,31 @@ func (c *ChimeSDKVoice) CreateVoiceProfileDomainRequest(input *CreateVoiceProfil // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain func (c *ChimeSDKVoice) CreateVoiceProfileDomain(input *CreateVoiceProfileDomainInput) (*CreateVoiceProfileDomainOutput, error) { @@ -1233,6 +1409,13 @@ func (c *ChimeSDKVoice) DeletePhoneNumberRequest(input *DeletePhoneNumberInput) // DeletePhoneNumber API operation for Amazon Chime SDK Voice. // +// Moves the specified phone number into the Deletion queue. A phone number +// must be disassociated from any users or Amazon Chime SDK Voice Connectors +// before it can be deleted. +// +// Deleted phone numbers remain in the Deletion queue queue for 7 days before +// they are deleted permanently. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1243,18 +1426,25 @@ func (c *ChimeSDKVoice) DeletePhoneNumberRequest(input *DeletePhoneNumberInput) // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeletePhoneNumber func (c *ChimeSDKVoice) DeletePhoneNumber(input *DeletePhoneNumberInput) (*DeletePhoneNumberOutput, error) { @@ -1322,6 +1512,9 @@ func (c *ChimeSDKVoice) DeleteProxySessionRequest(input *DeleteProxySessionInput // DeleteProxySession API operation for Amazon Chime SDK Voice. // +// Deletes the specified proxy session from the specified Amazon Chime SDK Voice +// Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1332,18 +1525,25 @@ func (c *ChimeSDKVoice) DeleteProxySessionRequest(input *DeleteProxySessionInput // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteProxySession func (c *ChimeSDKVoice) DeleteProxySession(input *DeleteProxySessionInput) (*DeleteProxySessionOutput, error) { @@ -1411,6 +1611,8 @@ func (c *ChimeSDKVoice) DeleteSipMediaApplicationRequest(input *DeleteSipMediaAp // DeleteSipMediaApplication API operation for Amazon Chime SDK Voice. // +// Deletes a SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1421,20 +1623,28 @@ func (c *ChimeSDKVoice) DeleteSipMediaApplicationRequest(input *DeleteSipMediaAp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication func (c *ChimeSDKVoice) DeleteSipMediaApplication(input *DeleteSipMediaApplicationInput) (*DeleteSipMediaApplicationOutput, error) { @@ -1502,6 +1712,8 @@ func (c *ChimeSDKVoice) DeleteSipRuleRequest(input *DeleteSipRuleInput) (req *re // DeleteSipRule API operation for Amazon Chime SDK Voice. // +// Deletes a SIP rule. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1512,20 +1724,28 @@ func (c *ChimeSDKVoice) DeleteSipRuleRequest(input *DeleteSipRuleInput) (req *re // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipRule func (c *ChimeSDKVoice) DeleteSipRule(input *DeleteSipRuleInput) (*DeleteSipRuleOutput, error) { @@ -1593,6 +1813,10 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorRequest(input *DeleteVoiceConnectorI // DeleteVoiceConnector API operation for Amazon Chime SDK Voice. // +// Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated +// with the Amazon Chime SDK Voice Connector must be disassociated from it before +// it can be deleted. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1603,20 +1827,28 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorRequest(input *DeleteVoiceConnectorI // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnector func (c *ChimeSDKVoice) DeleteVoiceConnector(input *DeleteVoiceConnectorInput) (*DeleteVoiceConnectorOutput, error) { @@ -1684,6 +1916,9 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorEmergencyCallingConfigurationRequest // DeleteVoiceConnectorEmergencyCallingConfiguration API operation for Amazon Chime SDK Voice. // +// Deletes the emergency calling details from the specified Amazon Chime SDK +// Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1694,18 +1929,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorEmergencyCallingConfigurationRequest // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration func (c *ChimeSDKVoice) DeleteVoiceConnectorEmergencyCallingConfiguration(input *DeleteVoiceConnectorEmergencyCallingConfigurationInput) (*DeleteVoiceConnectorEmergencyCallingConfigurationOutput, error) { @@ -1773,6 +2015,10 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorGroupRequest(input *DeleteVoiceConne // DeleteVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems +// and phone numbers associated with the group must be removed before it can +// be deleted. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1783,20 +2029,28 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorGroupRequest(input *DeleteVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup func (c *ChimeSDKVoice) DeleteVoiceConnectorGroup(input *DeleteVoiceConnectorGroupInput) (*DeleteVoiceConnectorGroupOutput, error) { @@ -1864,6 +2118,12 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorOriginationRequest(input *DeleteVoic // DeleteVoiceConnectorOrigination API operation for Amazon Chime SDK Voice. // +// Deletes the origination settings for the specified Amazon Chime SDK Voice +// Connector. +// +// If emergency calling is configured for the Voice Connector, it must be deleted +// prior to deleting the origination settings. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1874,18 +2134,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorOriginationRequest(input *DeleteVoic // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination func (c *ChimeSDKVoice) DeleteVoiceConnectorOrigination(input *DeleteVoiceConnectorOriginationInput) (*DeleteVoiceConnectorOriginationOutput, error) { @@ -1953,6 +2220,9 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorProxyRequest(input *DeleteVoiceConne // DeleteVoiceConnectorProxy API operation for Amazon Chime SDK Voice. // +// Deletes the proxy configuration from the specified Amazon Chime SDK Voice +// Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1963,18 +2233,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorProxyRequest(input *DeleteVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy func (c *ChimeSDKVoice) DeleteVoiceConnectorProxy(input *DeleteVoiceConnectorProxyInput) (*DeleteVoiceConnectorProxyOutput, error) { @@ -2042,6 +2319,8 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorStreamingConfigurationRequest(input // DeleteVoiceConnectorStreamingConfiguration API operation for Amazon Chime SDK Voice. // +// Deletes a Voice Connector's streaming configuration. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2052,18 +2331,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorStreamingConfigurationRequest(input // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration func (c *ChimeSDKVoice) DeleteVoiceConnectorStreamingConfiguration(input *DeleteVoiceConnectorStreamingConfigurationInput) (*DeleteVoiceConnectorStreamingConfigurationOutput, error) { @@ -2131,6 +2417,12 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorTerminationRequest(input *DeleteVoic // DeleteVoiceConnectorTermination API operation for Amazon Chime SDK Voice. // +// Deletes the termination settings for the specified Amazon Chime SDK Voice +// Connector. +// +// If emergency calling is configured for the Voice Connector, it must be deleted +// prior to deleting the termination settings. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2141,18 +2433,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorTerminationRequest(input *DeleteVoic // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination func (c *ChimeSDKVoice) DeleteVoiceConnectorTermination(input *DeleteVoiceConnectorTerminationInput) (*DeleteVoiceConnectorTerminationOutput, error) { @@ -2220,6 +2519,9 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorTerminationCredentialsRequest(input // DeleteVoiceConnectorTerminationCredentials API operation for Amazon Chime SDK Voice. // +// Deletes the specified SIP credentials used by your equipment to authenticate +// during call termination. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2230,18 +2532,25 @@ func (c *ChimeSDKVoice) DeleteVoiceConnectorTerminationCredentialsRequest(input // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials func (c *ChimeSDKVoice) DeleteVoiceConnectorTerminationCredentials(input *DeleteVoiceConnectorTerminationCredentialsInput) (*DeleteVoiceConnectorTerminationCredentialsOutput, error) { @@ -2309,6 +2618,9 @@ func (c *ChimeSDKVoice) DeleteVoiceProfileRequest(input *DeleteVoiceProfileInput // DeleteVoiceProfile API operation for Amazon Chime SDK Voice. // +// Deletes a voice profile, including its voice print and enrollment data. WARNING: +// This action is not reversible. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2319,22 +2631,31 @@ func (c *ChimeSDKVoice) DeleteVoiceProfileRequest(input *DeleteVoiceProfileInput // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfile func (c *ChimeSDKVoice) DeleteVoiceProfile(input *DeleteVoiceProfileInput) (*DeleteVoiceProfileOutput, error) { @@ -2402,6 +2723,8 @@ func (c *ChimeSDKVoice) DeleteVoiceProfileDomainRequest(input *DeleteVoiceProfil // DeleteVoiceProfileDomain API operation for Amazon Chime SDK Voice. // +// Deletes all voice profiles in the domain. WARNING: This action is not reversible. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2412,22 +2735,31 @@ func (c *ChimeSDKVoice) DeleteVoiceProfileDomainRequest(input *DeleteVoiceProfil // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain func (c *ChimeSDKVoice) DeleteVoiceProfileDomain(input *DeleteVoiceProfileDomainInput) (*DeleteVoiceProfileDomainOutput, error) { @@ -2494,6 +2826,9 @@ func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnectorRequest(input // DisassociatePhoneNumbersFromVoiceConnector API operation for Amazon Chime SDK Voice. // +// Disassociates the specified phone numbers from the specified Amazon Chime +// SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2504,18 +2839,25 @@ func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnectorRequest(input // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnector(input *DisassociatePhoneNumbersFromVoiceConnectorInput) (*DisassociatePhoneNumbersFromVoiceConnectorOutput, error) { @@ -2582,6 +2924,9 @@ func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnectorGroupRequest(i // DisassociatePhoneNumbersFromVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Disassociates the specified phone numbers from the specified Amazon Chime +// SDK Voice Connector group. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2592,18 +2937,25 @@ func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnectorGroupRequest(i // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup func (c *ChimeSDKVoice) DisassociatePhoneNumbersFromVoiceConnectorGroup(input *DisassociatePhoneNumbersFromVoiceConnectorGroupInput) (*DisassociatePhoneNumbersFromVoiceConnectorGroupOutput, error) { @@ -2670,6 +3022,9 @@ func (c *ChimeSDKVoice) GetGlobalSettingsRequest(input *GetGlobalSettingsInput) // GetGlobalSettings API operation for Amazon Chime SDK Voice. // +// Retrieves the global settings for the Amazon Chime SDK Voice Connectors in +// an AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2680,16 +3035,22 @@ func (c *ChimeSDKVoice) GetGlobalSettingsRequest(input *GetGlobalSettingsInput) // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetGlobalSettings func (c *ChimeSDKVoice) GetGlobalSettings(input *GetGlobalSettingsInput) (*GetGlobalSettingsOutput, error) { @@ -2756,6 +3117,9 @@ func (c *ChimeSDKVoice) GetPhoneNumberRequest(input *GetPhoneNumberInput) (req * // GetPhoneNumber API operation for Amazon Chime SDK Voice. // +// Retrieves details for the specified phone number ID, such as associations, +// capabilities, and product type. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2766,18 +3130,25 @@ func (c *ChimeSDKVoice) GetPhoneNumberRequest(input *GetPhoneNumberInput) (req * // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumber func (c *ChimeSDKVoice) GetPhoneNumber(input *GetPhoneNumberInput) (*GetPhoneNumberOutput, error) { @@ -2844,6 +3215,10 @@ func (c *ChimeSDKVoice) GetPhoneNumberOrderRequest(input *GetPhoneNumberOrderInp // GetPhoneNumberOrder API operation for Amazon Chime SDK Voice. // +// Retrieves details for the specified phone number order, such as the order +// creation timestamp, phone numbers in E.164 format, product type, and order +// status. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2854,18 +3229,25 @@ func (c *ChimeSDKVoice) GetPhoneNumberOrderRequest(input *GetPhoneNumberOrderInp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder func (c *ChimeSDKVoice) GetPhoneNumberOrder(input *GetPhoneNumberOrderInput) (*GetPhoneNumberOrderOutput, error) { @@ -2932,6 +3314,9 @@ func (c *ChimeSDKVoice) GetPhoneNumberSettingsRequest(input *GetPhoneNumberSetti // GetPhoneNumberSettings API operation for Amazon Chime SDK Voice. // +// Retrieves the phone number settings for the administrator's AWS account, +// such as the default outbound calling name. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2942,16 +3327,22 @@ func (c *ChimeSDKVoice) GetPhoneNumberSettingsRequest(input *GetPhoneNumberSetti // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings func (c *ChimeSDKVoice) GetPhoneNumberSettings(input *GetPhoneNumberSettingsInput) (*GetPhoneNumberSettingsOutput, error) { @@ -3018,6 +3409,9 @@ func (c *ChimeSDKVoice) GetProxySessionRequest(input *GetProxySessionInput) (req // GetProxySession API operation for Amazon Chime SDK Voice. // +// Retrieves the specified proxy session details for the specified Amazon Chime +// SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3028,18 +3422,25 @@ func (c *ChimeSDKVoice) GetProxySessionRequest(input *GetProxySessionInput) (req // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySession func (c *ChimeSDKVoice) GetProxySession(input *GetProxySessionInput) (*GetProxySessionOutput, error) { @@ -3106,6 +3507,9 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationRequest(input *GetSipMediaApplicat // GetSipMediaApplication API operation for Amazon Chime SDK Voice. // +// Retrieves the information for a SIP media application, including name, AWS +// Region, and endpoints. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3116,18 +3520,25 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationRequest(input *GetSipMediaApplicat // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplication func (c *ChimeSDKVoice) GetSipMediaApplication(input *GetSipMediaApplicationInput) (*GetSipMediaApplicationOutput, error) { @@ -3194,6 +3605,8 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationAlexaSkillConfigurationRequest(inp // GetSipMediaApplicationAlexaSkillConfiguration API operation for Amazon Chime SDK Voice. // +// Gets the Alexa Skill configuration for the SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3204,18 +3617,25 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationAlexaSkillConfigurationRequest(inp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration func (c *ChimeSDKVoice) GetSipMediaApplicationAlexaSkillConfiguration(input *GetSipMediaApplicationAlexaSkillConfigurationInput) (*GetSipMediaApplicationAlexaSkillConfigurationOutput, error) { @@ -3282,6 +3702,8 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationLoggingConfigurationRequest(input // GetSipMediaApplicationLoggingConfiguration API operation for Amazon Chime SDK Voice. // +// Retrieves the logging configuration for the specified SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3292,18 +3714,25 @@ func (c *ChimeSDKVoice) GetSipMediaApplicationLoggingConfigurationRequest(input // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration func (c *ChimeSDKVoice) GetSipMediaApplicationLoggingConfiguration(input *GetSipMediaApplicationLoggingConfigurationInput) (*GetSipMediaApplicationLoggingConfigurationOutput, error) { @@ -3370,6 +3799,9 @@ func (c *ChimeSDKVoice) GetSipRuleRequest(input *GetSipRuleInput) (req *request. // GetSipRule API operation for Amazon Chime SDK Voice. // +// Retrieves the details of a SIP rule, such as the rule ID, name, triggers, +// and target endpoints. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3380,18 +3812,25 @@ func (c *ChimeSDKVoice) GetSipRuleRequest(input *GetSipRuleInput) (req *request. // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRule func (c *ChimeSDKVoice) GetSipRule(input *GetSipRuleInput) (*GetSipRuleOutput, error) { @@ -3458,6 +3897,8 @@ func (c *ChimeSDKVoice) GetSpeakerSearchTaskRequest(input *GetSpeakerSearchTaskI // GetSpeakerSearchTask API operation for Amazon Chime SDK Voice. // +// Retrieves the details of the specified speaker search task. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3468,22 +3909,31 @@ func (c *ChimeSDKVoice) GetSpeakerSearchTaskRequest(input *GetSpeakerSearchTaskI // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceFailureException +// The service encountered an unexpected error. // // - ServiceUnavailableException +// The service is currently unavailable. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask func (c *ChimeSDKVoice) GetSpeakerSearchTask(input *GetSpeakerSearchTaskInput) (*GetSpeakerSearchTaskOutput, error) { @@ -3550,6 +4000,9 @@ func (c *ChimeSDKVoice) GetVoiceConnectorRequest(input *GetVoiceConnectorInput) // GetVoiceConnector API operation for Amazon Chime SDK Voice. // +// Retrieves details for the specified Amazon Chime SDK Voice Connector, such +// as timestamps,name, outbound host, and encryption requirements. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3560,18 +4013,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorRequest(input *GetVoiceConnectorInput) // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnector func (c *ChimeSDKVoice) GetVoiceConnector(input *GetVoiceConnectorInput) (*GetVoiceConnectorOutput, error) { @@ -3638,6 +4098,9 @@ func (c *ChimeSDKVoice) GetVoiceConnectorEmergencyCallingConfigurationRequest(in // GetVoiceConnectorEmergencyCallingConfiguration API operation for Amazon Chime SDK Voice. // +// Retrieves the emergency calling configuration details for the specified Voice +// Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3648,18 +4111,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorEmergencyCallingConfigurationRequest(in // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration func (c *ChimeSDKVoice) GetVoiceConnectorEmergencyCallingConfiguration(input *GetVoiceConnectorEmergencyCallingConfigurationInput) (*GetVoiceConnectorEmergencyCallingConfigurationOutput, error) { @@ -3726,6 +4196,9 @@ func (c *ChimeSDKVoice) GetVoiceConnectorGroupRequest(input *GetVoiceConnectorGr // GetVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Retrieves details for the specified Amazon Chime SDK Voice Connector group, +// such as timestamps,name, and associated VoiceConnectorItems. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3736,18 +4209,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorGroupRequest(input *GetVoiceConnectorGr // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup func (c *ChimeSDKVoice) GetVoiceConnectorGroup(input *GetVoiceConnectorGroupInput) (*GetVoiceConnectorGroupOutput, error) { @@ -3814,6 +4294,10 @@ func (c *ChimeSDKVoice) GetVoiceConnectorLoggingConfigurationRequest(input *GetV // GetVoiceConnectorLoggingConfiguration API operation for Amazon Chime SDK Voice. // +// Retrieves the logging configuration settings for the specified Voice Connector. +// Shows whether SIP message logs are enabled for sending to Amazon CloudWatch +// Logs. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3824,18 +4308,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorLoggingConfigurationRequest(input *GetV // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration func (c *ChimeSDKVoice) GetVoiceConnectorLoggingConfiguration(input *GetVoiceConnectorLoggingConfigurationInput) (*GetVoiceConnectorLoggingConfigurationOutput, error) { @@ -3902,6 +4393,8 @@ func (c *ChimeSDKVoice) GetVoiceConnectorOriginationRequest(input *GetVoiceConne // GetVoiceConnectorOrigination API operation for Amazon Chime SDK Voice. // +// Retrieves the origination settings for the specified Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3912,18 +4405,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorOriginationRequest(input *GetVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination func (c *ChimeSDKVoice) GetVoiceConnectorOrigination(input *GetVoiceConnectorOriginationInput) (*GetVoiceConnectorOriginationOutput, error) { @@ -3990,6 +4490,9 @@ func (c *ChimeSDKVoice) GetVoiceConnectorProxyRequest(input *GetVoiceConnectorPr // GetVoiceConnectorProxy API operation for Amazon Chime SDK Voice. // +// Retrieves the proxy configuration details for the specified Amazon Chime +// SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4000,18 +4503,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorProxyRequest(input *GetVoiceConnectorPr // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy func (c *ChimeSDKVoice) GetVoiceConnectorProxy(input *GetVoiceConnectorProxyInput) (*GetVoiceConnectorProxyOutput, error) { @@ -4078,6 +4588,11 @@ func (c *ChimeSDKVoice) GetVoiceConnectorStreamingConfigurationRequest(input *Ge // GetVoiceConnectorStreamingConfiguration API operation for Amazon Chime SDK Voice. // +// Retrieves the streaming configuration details for the specified Amazon Chime +// SDK Voice Connector. Shows whether media streaming is enabled for sending +// to Amazon Kinesis. It also shows the retention period, in hours, for the +// Amazon Kinesis data. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4088,18 +4603,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorStreamingConfigurationRequest(input *Ge // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration func (c *ChimeSDKVoice) GetVoiceConnectorStreamingConfiguration(input *GetVoiceConnectorStreamingConfigurationInput) (*GetVoiceConnectorStreamingConfigurationOutput, error) { @@ -4166,6 +4688,8 @@ func (c *ChimeSDKVoice) GetVoiceConnectorTerminationRequest(input *GetVoiceConne // GetVoiceConnectorTermination API operation for Amazon Chime SDK Voice. // +// Retrieves the termination setting details for the specified Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4176,18 +4700,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorTerminationRequest(input *GetVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination func (c *ChimeSDKVoice) GetVoiceConnectorTermination(input *GetVoiceConnectorTerminationInput) (*GetVoiceConnectorTerminationOutput, error) { @@ -4254,6 +4785,9 @@ func (c *ChimeSDKVoice) GetVoiceConnectorTerminationHealthRequest(input *GetVoic // GetVoiceConnectorTerminationHealth API operation for Amazon Chime SDK Voice. // +// Retrieves information about the last time a SIP OPTIONS ping was received +// from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4264,18 +4798,25 @@ func (c *ChimeSDKVoice) GetVoiceConnectorTerminationHealthRequest(input *GetVoic // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth func (c *ChimeSDKVoice) GetVoiceConnectorTerminationHealth(input *GetVoiceConnectorTerminationHealthInput) (*GetVoiceConnectorTerminationHealthOutput, error) { @@ -4342,6 +4883,8 @@ func (c *ChimeSDKVoice) GetVoiceProfileRequest(input *GetVoiceProfileInput) (req // GetVoiceProfile API operation for Amazon Chime SDK Voice. // +// Retrieves the details of the specified voice profile. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4352,20 +4895,28 @@ func (c *ChimeSDKVoice) GetVoiceProfileRequest(input *GetVoiceProfileInput) (req // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfile func (c *ChimeSDKVoice) GetVoiceProfile(input *GetVoiceProfileInput) (*GetVoiceProfileOutput, error) { @@ -4432,6 +4983,8 @@ func (c *ChimeSDKVoice) GetVoiceProfileDomainRequest(input *GetVoiceProfileDomai // GetVoiceProfileDomain API operation for Amazon Chime SDK Voice. // +// Retrieves the details of the specified voice profile domain. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4442,20 +4995,28 @@ func (c *ChimeSDKVoice) GetVoiceProfileDomainRequest(input *GetVoiceProfileDomai // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain func (c *ChimeSDKVoice) GetVoiceProfileDomain(input *GetVoiceProfileDomainInput) (*GetVoiceProfileDomainOutput, error) { @@ -4522,6 +5083,8 @@ func (c *ChimeSDKVoice) GetVoiceToneAnalysisTaskRequest(input *GetVoiceToneAnaly // GetVoiceToneAnalysisTask API operation for Amazon Chime SDK Voice. // +// Retrieves the details of a voice tone analysis task. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4532,22 +5095,31 @@ func (c *ChimeSDKVoice) GetVoiceToneAnalysisTaskRequest(input *GetVoiceToneAnaly // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceFailureException +// The service encountered an unexpected error. // // - ServiceUnavailableException +// The service is currently unavailable. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask func (c *ChimeSDKVoice) GetVoiceToneAnalysisTask(input *GetVoiceToneAnalysisTaskInput) (*GetVoiceToneAnalysisTaskOutput, error) { @@ -4614,6 +5186,9 @@ func (c *ChimeSDKVoice) ListAvailableVoiceConnectorRegionsRequest(input *ListAva // ListAvailableVoiceConnectorRegions API operation for Amazon Chime SDK Voice. // +// Lists the available AWS Regions in which you can create an Amazon Chime SDK +// Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4624,16 +5199,22 @@ func (c *ChimeSDKVoice) ListAvailableVoiceConnectorRegionsRequest(input *ListAva // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions func (c *ChimeSDKVoice) ListAvailableVoiceConnectorRegions(input *ListAvailableVoiceConnectorRegionsInput) (*ListAvailableVoiceConnectorRegionsOutput, error) { @@ -4706,6 +5287,8 @@ func (c *ChimeSDKVoice) ListPhoneNumberOrdersRequest(input *ListPhoneNumberOrder // ListPhoneNumberOrders API operation for Amazon Chime SDK Voice. // +// Lists the phone numbers for an administrator's Amazon Chime SDK account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4716,16 +5299,22 @@ func (c *ChimeSDKVoice) ListPhoneNumberOrdersRequest(input *ListPhoneNumberOrder // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders func (c *ChimeSDKVoice) ListPhoneNumberOrders(input *ListPhoneNumberOrdersInput) (*ListPhoneNumberOrdersOutput, error) { @@ -4849,6 +5438,10 @@ func (c *ChimeSDKVoice) ListPhoneNumbersRequest(input *ListPhoneNumbersInput) (r // ListPhoneNumbers API operation for Amazon Chime SDK Voice. // +// Lists the phone numbers for the specified Amazon Chime SDK account, Amazon +// Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice +// Connector group. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4859,18 +5452,25 @@ func (c *ChimeSDKVoice) ListPhoneNumbersRequest(input *ListPhoneNumbersInput) (r // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - NotFoundException +// The requested resource couldn't be found. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbers func (c *ChimeSDKVoice) ListPhoneNumbers(input *ListPhoneNumbersInput) (*ListPhoneNumbersOutput, error) { @@ -4994,6 +5594,8 @@ func (c *ChimeSDKVoice) ListProxySessionsRequest(input *ListProxySessionsInput) // ListProxySessions API operation for Amazon Chime SDK Voice. // +// Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5004,18 +5606,25 @@ func (c *ChimeSDKVoice) ListProxySessionsRequest(input *ListProxySessionsInput) // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessions func (c *ChimeSDKVoice) ListProxySessions(input *ListProxySessionsInput) (*ListProxySessionsOutput, error) { @@ -5139,6 +5748,8 @@ func (c *ChimeSDKVoice) ListSipMediaApplicationsRequest(input *ListSipMediaAppli // ListSipMediaApplications API operation for Amazon Chime SDK Voice. // +// Lists the SIP media applications under the administrator's AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5149,16 +5760,22 @@ func (c *ChimeSDKVoice) ListSipMediaApplicationsRequest(input *ListSipMediaAppli // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplications func (c *ChimeSDKVoice) ListSipMediaApplications(input *ListSipMediaApplicationsInput) (*ListSipMediaApplicationsOutput, error) { @@ -5282,6 +5899,8 @@ func (c *ChimeSDKVoice) ListSipRulesRequest(input *ListSipRulesInput) (req *requ // ListSipRules API operation for Amazon Chime SDK Voice. // +// Lists the SIP rules under the administrator's AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5292,16 +5911,22 @@ func (c *ChimeSDKVoice) ListSipRulesRequest(input *ListSipRulesInput) (req *requ // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRules func (c *ChimeSDKVoice) ListSipRules(input *ListSipRulesInput) (*ListSipRulesOutput, error) { @@ -5419,6 +6044,8 @@ func (c *ChimeSDKVoice) ListSupportedPhoneNumberCountriesRequest(input *ListSupp // ListSupportedPhoneNumberCountries API operation for Amazon Chime SDK Voice. // +// Lists the countries that you can order phone numbers from. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5429,18 +6056,25 @@ func (c *ChimeSDKVoice) ListSupportedPhoneNumberCountriesRequest(input *ListSupp // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries func (c *ChimeSDKVoice) ListSupportedPhoneNumberCountries(input *ListSupportedPhoneNumberCountriesInput) (*ListSupportedPhoneNumberCountriesOutput, error) { @@ -5507,6 +6141,8 @@ func (c *ChimeSDKVoice) ListTagsForResourceRequest(input *ListTagsForResourceInp // ListTagsForResource API operation for Amazon Chime SDK Voice. // +// Returns a list of the tags in a given resource. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5517,16 +6153,22 @@ func (c *ChimeSDKVoice) ListTagsForResourceRequest(input *ListTagsForResourceInp // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - NotFoundException +// The requested resource couldn't be found. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResource func (c *ChimeSDKVoice) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { @@ -5599,6 +6241,9 @@ func (c *ChimeSDKVoice) ListVoiceConnectorGroupsRequest(input *ListVoiceConnecto // ListVoiceConnectorGroups API operation for Amazon Chime SDK Voice. // +// Lists the Amazon Chime SDK Voice Connector groups in the administrator's +// AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5609,16 +6254,22 @@ func (c *ChimeSDKVoice) ListVoiceConnectorGroupsRequest(input *ListVoiceConnecto // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups func (c *ChimeSDKVoice) ListVoiceConnectorGroups(input *ListVoiceConnectorGroupsInput) (*ListVoiceConnectorGroupsOutput, error) { @@ -5736,6 +6387,8 @@ func (c *ChimeSDKVoice) ListVoiceConnectorTerminationCredentialsRequest(input *L // ListVoiceConnectorTerminationCredentials API operation for Amazon Chime SDK Voice. // +// Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5746,18 +6399,25 @@ func (c *ChimeSDKVoice) ListVoiceConnectorTerminationCredentialsRequest(input *L // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials func (c *ChimeSDKVoice) ListVoiceConnectorTerminationCredentials(input *ListVoiceConnectorTerminationCredentialsInput) (*ListVoiceConnectorTerminationCredentialsOutput, error) { @@ -5830,6 +6490,8 @@ func (c *ChimeSDKVoice) ListVoiceConnectorsRequest(input *ListVoiceConnectorsInp // ListVoiceConnectors API operation for Amazon Chime SDK Voice. // +// Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5840,16 +6502,22 @@ func (c *ChimeSDKVoice) ListVoiceConnectorsRequest(input *ListVoiceConnectorsInp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectors func (c *ChimeSDKVoice) ListVoiceConnectors(input *ListVoiceConnectorsInput) (*ListVoiceConnectorsOutput, error) { @@ -5973,6 +6641,8 @@ func (c *ChimeSDKVoice) ListVoiceProfileDomainsRequest(input *ListVoiceProfileDo // ListVoiceProfileDomains API operation for Amazon Chime SDK Voice. // +// Lists the specified voice profile domains in the administrator's AWS account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5983,18 +6653,25 @@ func (c *ChimeSDKVoice) ListVoiceProfileDomainsRequest(input *ListVoiceProfileDo // Returned Error Types: // // - NotFoundException +// The requested resource couldn't be found. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains func (c *ChimeSDKVoice) ListVoiceProfileDomains(input *ListVoiceProfileDomainsInput) (*ListVoiceProfileDomainsOutput, error) { @@ -6118,6 +6795,8 @@ func (c *ChimeSDKVoice) ListVoiceProfilesRequest(input *ListVoiceProfilesInput) // ListVoiceProfiles API operation for Amazon Chime SDK Voice. // +// Lists the voice profiles in a voice profile domain. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6128,18 +6807,25 @@ func (c *ChimeSDKVoice) ListVoiceProfilesRequest(input *ListVoiceProfilesInput) // Returned Error Types: // // - NotFoundException +// The requested resource couldn't be found. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfiles func (c *ChimeSDKVoice) ListVoiceProfiles(input *ListVoiceProfilesInput) (*ListVoiceProfilesOutput, error) { @@ -6257,6 +6943,8 @@ func (c *ChimeSDKVoice) PutSipMediaApplicationAlexaSkillConfigurationRequest(inp // PutSipMediaApplicationAlexaSkillConfiguration API operation for Amazon Chime SDK Voice. // +// Updates the Alexa Skill configuration for the SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6267,18 +6955,25 @@ func (c *ChimeSDKVoice) PutSipMediaApplicationAlexaSkillConfigurationRequest(inp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration func (c *ChimeSDKVoice) PutSipMediaApplicationAlexaSkillConfiguration(input *PutSipMediaApplicationAlexaSkillConfigurationInput) (*PutSipMediaApplicationAlexaSkillConfigurationOutput, error) { @@ -6345,6 +7040,8 @@ func (c *ChimeSDKVoice) PutSipMediaApplicationLoggingConfigurationRequest(input // PutSipMediaApplicationLoggingConfiguration API operation for Amazon Chime SDK Voice. // +// Updates the logging configuration for the specified SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6355,18 +7052,25 @@ func (c *ChimeSDKVoice) PutSipMediaApplicationLoggingConfigurationRequest(input // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration func (c *ChimeSDKVoice) PutSipMediaApplicationLoggingConfiguration(input *PutSipMediaApplicationLoggingConfigurationInput) (*PutSipMediaApplicationLoggingConfigurationOutput, error) { @@ -6433,6 +7137,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorEmergencyCallingConfigurationRequest(in // PutVoiceConnectorEmergencyCallingConfiguration API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's emergency calling configuration. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6443,18 +7149,25 @@ func (c *ChimeSDKVoice) PutVoiceConnectorEmergencyCallingConfigurationRequest(in // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration func (c *ChimeSDKVoice) PutVoiceConnectorEmergencyCallingConfiguration(input *PutVoiceConnectorEmergencyCallingConfigurationInput) (*PutVoiceConnectorEmergencyCallingConfigurationOutput, error) { @@ -6521,6 +7234,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorLoggingConfigurationRequest(input *PutV // PutVoiceConnectorLoggingConfiguration API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's logging configuration. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6531,18 +7246,25 @@ func (c *ChimeSDKVoice) PutVoiceConnectorLoggingConfigurationRequest(input *PutV // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration func (c *ChimeSDKVoice) PutVoiceConnectorLoggingConfiguration(input *PutVoiceConnectorLoggingConfigurationInput) (*PutVoiceConnectorLoggingConfigurationOutput, error) { @@ -6609,6 +7331,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorOriginationRequest(input *PutVoiceConne // PutVoiceConnectorOrigination API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's origination settings. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6619,18 +7343,25 @@ func (c *ChimeSDKVoice) PutVoiceConnectorOriginationRequest(input *PutVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination func (c *ChimeSDKVoice) PutVoiceConnectorOrigination(input *PutVoiceConnectorOriginationInput) (*PutVoiceConnectorOriginationOutput, error) { @@ -6697,6 +7428,9 @@ func (c *ChimeSDKVoice) PutVoiceConnectorProxyRequest(input *PutVoiceConnectorPr // PutVoiceConnectorProxy API operation for Amazon Chime SDK Voice. // +// Puts the specified proxy configuration to the specified Amazon Chime SDK +// Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6707,20 +7441,28 @@ func (c *ChimeSDKVoice) PutVoiceConnectorProxyRequest(input *PutVoiceConnectorPr // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy func (c *ChimeSDKVoice) PutVoiceConnectorProxy(input *PutVoiceConnectorProxyInput) (*PutVoiceConnectorProxyOutput, error) { @@ -6787,6 +7529,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorStreamingConfigurationRequest(input *Pu // PutVoiceConnectorStreamingConfiguration API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's streaming configuration settings. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6797,18 +7541,25 @@ func (c *ChimeSDKVoice) PutVoiceConnectorStreamingConfigurationRequest(input *Pu // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration func (c *ChimeSDKVoice) PutVoiceConnectorStreamingConfiguration(input *PutVoiceConnectorStreamingConfigurationInput) (*PutVoiceConnectorStreamingConfigurationOutput, error) { @@ -6875,6 +7626,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorTerminationRequest(input *PutVoiceConne // PutVoiceConnectorTermination API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's termination settings. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6885,20 +7638,28 @@ func (c *ChimeSDKVoice) PutVoiceConnectorTerminationRequest(input *PutVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination func (c *ChimeSDKVoice) PutVoiceConnectorTermination(input *PutVoiceConnectorTerminationInput) (*PutVoiceConnectorTerminationOutput, error) { @@ -6966,6 +7727,8 @@ func (c *ChimeSDKVoice) PutVoiceConnectorTerminationCredentialsRequest(input *Pu // PutVoiceConnectorTerminationCredentials API operation for Amazon Chime SDK Voice. // +// Updates a Voice Connector's termination credentials. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6976,18 +7739,25 @@ func (c *ChimeSDKVoice) PutVoiceConnectorTerminationCredentialsRequest(input *Pu // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials func (c *ChimeSDKVoice) PutVoiceConnectorTerminationCredentials(input *PutVoiceConnectorTerminationCredentialsInput) (*PutVoiceConnectorTerminationCredentialsOutput, error) { @@ -7054,6 +7824,8 @@ func (c *ChimeSDKVoice) RestorePhoneNumberRequest(input *RestorePhoneNumberInput // RestorePhoneNumber API operation for Amazon Chime SDK Voice. // +// Restores a deleted phone number. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7064,20 +7836,28 @@ func (c *ChimeSDKVoice) RestorePhoneNumberRequest(input *RestorePhoneNumberInput // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumber func (c *ChimeSDKVoice) RestorePhoneNumber(input *RestorePhoneNumberInput) (*RestorePhoneNumberOutput, error) { @@ -7150,6 +7930,8 @@ func (c *ChimeSDKVoice) SearchAvailablePhoneNumbersRequest(input *SearchAvailabl // SearchAvailablePhoneNumbers API operation for Amazon Chime SDK Voice. // +// Searches the provisioned phone numbers in an organization. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7160,18 +7942,25 @@ func (c *ChimeSDKVoice) SearchAvailablePhoneNumbersRequest(input *SearchAvailabl // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers func (c *ChimeSDKVoice) SearchAvailablePhoneNumbers(input *SearchAvailablePhoneNumbersInput) (*SearchAvailablePhoneNumbersOutput, error) { @@ -7289,6 +8078,13 @@ func (c *ChimeSDKVoice) StartSpeakerSearchTaskRequest(input *StartSpeakerSearchT // StartSpeakerSearchTask API operation for Amazon Chime SDK Voice. // +// Starts a speaker search task. +// +// Before starting any speaker search tasks, you must provide all notices and +// obtain all consents from the speaker as required under applicable privacy +// and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) +// for the Amazon Chime SDK. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7299,28 +8095,41 @@ func (c *ChimeSDKVoice) StartSpeakerSearchTaskRequest(input *StartSpeakerSearchT // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - GoneException +// Access to the target resource is no longer available at the origin server. +// This condition is likely to be permanent. // // - UnprocessableEntityException +// A well-formed request couldn't be followed due to semantic errors. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask func (c *ChimeSDKVoice) StartSpeakerSearchTask(input *StartSpeakerSearchTaskInput) (*StartSpeakerSearchTaskOutput, error) { @@ -7387,6 +8196,15 @@ func (c *ChimeSDKVoice) StartVoiceToneAnalysisTaskRequest(input *StartVoiceToneA // StartVoiceToneAnalysisTask API operation for Amazon Chime SDK Voice. // +// Starts a voice tone analysis task. For more information about voice tone +// analysis, see Using Amazon Chime SDK voice analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. +// +// Before starting any voice tone analysis tasks, you must provide all notices +// and obtain all consents from the speaker as required under applicable privacy +// and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) +// for the Amazon Chime SDK. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7397,28 +8215,41 @@ func (c *ChimeSDKVoice) StartVoiceToneAnalysisTaskRequest(input *StartVoiceToneA // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - GoneException +// Access to the target resource is no longer available at the origin server. +// This condition is likely to be permanent. // // - UnprocessableEntityException +// A well-formed request couldn't be followed due to semantic errors. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask func (c *ChimeSDKVoice) StartVoiceToneAnalysisTask(input *StartVoiceToneAnalysisTaskInput) (*StartVoiceToneAnalysisTaskOutput, error) { @@ -7486,6 +8317,8 @@ func (c *ChimeSDKVoice) StopSpeakerSearchTaskRequest(input *StopSpeakerSearchTas // StopSpeakerSearchTask API operation for Amazon Chime SDK Voice. // +// Stops a speaker search task. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7496,24 +8329,34 @@ func (c *ChimeSDKVoice) StopSpeakerSearchTaskRequest(input *StopSpeakerSearchTas // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - UnprocessableEntityException +// A well-formed request couldn't be followed due to semantic errors. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask func (c *ChimeSDKVoice) StopSpeakerSearchTask(input *StopSpeakerSearchTaskInput) (*StopSpeakerSearchTaskOutput, error) { @@ -7581,6 +8424,8 @@ func (c *ChimeSDKVoice) StopVoiceToneAnalysisTaskRequest(input *StopVoiceToneAna // StopVoiceToneAnalysisTask API operation for Amazon Chime SDK Voice. // +// Stops a voice tone analysis task. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7591,24 +8436,34 @@ func (c *ChimeSDKVoice) StopVoiceToneAnalysisTaskRequest(input *StopVoiceToneAna // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - UnprocessableEntityException +// A well-formed request couldn't be followed due to semantic errors. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask func (c *ChimeSDKVoice) StopVoiceToneAnalysisTask(input *StopVoiceToneAnalysisTaskInput) (*StopVoiceToneAnalysisTaskOutput, error) { @@ -7676,6 +8531,8 @@ func (c *ChimeSDKVoice) TagResourceRequest(input *TagResourceInput) (req *reques // TagResource API operation for Amazon Chime SDK Voice. // +// Adds a tag to the specified resource. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7686,18 +8543,25 @@ func (c *ChimeSDKVoice) TagResourceRequest(input *TagResourceInput) (req *reques // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - NotFoundException +// The requested resource couldn't be found. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TagResource func (c *ChimeSDKVoice) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { @@ -7765,6 +8629,8 @@ func (c *ChimeSDKVoice) UntagResourceRequest(input *UntagResourceInput) (req *re // UntagResource API operation for Amazon Chime SDK Voice. // +// Removes tags from a resource. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7775,16 +8641,22 @@ func (c *ChimeSDKVoice) UntagResourceRequest(input *UntagResourceInput) (req *re // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - NotFoundException +// The requested resource couldn't be found. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UntagResource func (c *ChimeSDKVoice) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { @@ -7852,6 +8724,9 @@ func (c *ChimeSDKVoice) UpdateGlobalSettingsRequest(input *UpdateGlobalSettingsI // UpdateGlobalSettings API operation for Amazon Chime SDK Voice. // +// Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS +// account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7862,16 +8737,22 @@ func (c *ChimeSDKVoice) UpdateGlobalSettingsRequest(input *UpdateGlobalSettingsI // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateGlobalSettings func (c *ChimeSDKVoice) UpdateGlobalSettings(input *UpdateGlobalSettingsInput) (*UpdateGlobalSettingsOutput, error) { @@ -7938,6 +8819,18 @@ func (c *ChimeSDKVoice) UpdatePhoneNumberRequest(input *UpdatePhoneNumberInput) // UpdatePhoneNumber API operation for Amazon Chime SDK Voice. // +// Updates phone number details, such as product type or calling name, for the +// specified phone number ID. You can update one phone number detail at a time. +// For example, you can update either the product type or the calling name in +// one action. +// +// For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media +// Application Dial-In product type. +// +// Updates to outbound calling names can take 72 hours to complete. Pending +// updates to outbound calling names must be complete before you can request +// another update. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7948,20 +8841,28 @@ func (c *ChimeSDKVoice) UpdatePhoneNumberRequest(input *UpdatePhoneNumberInput) // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumber func (c *ChimeSDKVoice) UpdatePhoneNumber(input *UpdatePhoneNumberInput) (*UpdatePhoneNumberOutput, error) { @@ -8029,6 +8930,11 @@ func (c *ChimeSDKVoice) UpdatePhoneNumberSettingsRequest(input *UpdatePhoneNumbe // UpdatePhoneNumberSettings API operation for Amazon Chime SDK Voice. // +// Updates the phone number settings for the administrator's AWS account, such +// as the default outbound calling name. You can update the default outbound +// calling name once every seven days. Outbound calling names can take up to +// 72 hours to update. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8039,16 +8945,22 @@ func (c *ChimeSDKVoice) UpdatePhoneNumberSettingsRequest(input *UpdatePhoneNumbe // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings func (c *ChimeSDKVoice) UpdatePhoneNumberSettings(input *UpdatePhoneNumberSettingsInput) (*UpdatePhoneNumberSettingsOutput, error) { @@ -8115,6 +9027,8 @@ func (c *ChimeSDKVoice) UpdateProxySessionRequest(input *UpdateProxySessionInput // UpdateProxySession API operation for Amazon Chime SDK Voice. // +// Updates the specified proxy session details, such as voice or SMS capabilities. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8125,18 +9039,25 @@ func (c *ChimeSDKVoice) UpdateProxySessionRequest(input *UpdateProxySessionInput // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySession func (c *ChimeSDKVoice) UpdateProxySession(input *UpdateProxySessionInput) (*UpdateProxySessionOutput, error) { @@ -8203,6 +9124,8 @@ func (c *ChimeSDKVoice) UpdateSipMediaApplicationRequest(input *UpdateSipMediaAp // UpdateSipMediaApplication API operation for Amazon Chime SDK Voice. // +// Updates the details of the specified SIP media application. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8213,20 +9136,28 @@ func (c *ChimeSDKVoice) UpdateSipMediaApplicationRequest(input *UpdateSipMediaAp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication func (c *ChimeSDKVoice) UpdateSipMediaApplication(input *UpdateSipMediaApplicationInput) (*UpdateSipMediaApplicationOutput, error) { @@ -8293,6 +9224,10 @@ func (c *ChimeSDKVoice) UpdateSipMediaApplicationCallRequest(input *UpdateSipMed // UpdateSipMediaApplicationCall API operation for Amazon Chime SDK Voice. // +// Invokes the AWS Lambda function associated with the SIP media application +// and transaction ID in an update request. The Lambda function can then return +// a new set of actions. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8303,20 +9238,28 @@ func (c *ChimeSDKVoice) UpdateSipMediaApplicationCallRequest(input *UpdateSipMed // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall func (c *ChimeSDKVoice) UpdateSipMediaApplicationCall(input *UpdateSipMediaApplicationCallInput) (*UpdateSipMediaApplicationCallOutput, error) { @@ -8383,6 +9326,8 @@ func (c *ChimeSDKVoice) UpdateSipRuleRequest(input *UpdateSipRuleInput) (req *re // UpdateSipRule API operation for Amazon Chime SDK Voice. // +// Updates the details of the specified SIP rule. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8393,22 +9338,31 @@ func (c *ChimeSDKVoice) UpdateSipRuleRequest(input *UpdateSipRuleInput) (req *re // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ResourceLimitExceededException +// The request exceeds the resource limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRule func (c *ChimeSDKVoice) UpdateSipRule(input *UpdateSipRuleInput) (*UpdateSipRuleOutput, error) { @@ -8475,6 +9429,8 @@ func (c *ChimeSDKVoice) UpdateVoiceConnectorRequest(input *UpdateVoiceConnectorI // UpdateVoiceConnector API operation for Amazon Chime SDK Voice. // +// Updates the details for the specified Amazon Chime SDK Voice Connector. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8485,18 +9441,25 @@ func (c *ChimeSDKVoice) UpdateVoiceConnectorRequest(input *UpdateVoiceConnectorI // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnector func (c *ChimeSDKVoice) UpdateVoiceConnector(input *UpdateVoiceConnectorInput) (*UpdateVoiceConnectorOutput, error) { @@ -8563,6 +9526,8 @@ func (c *ChimeSDKVoice) UpdateVoiceConnectorGroupRequest(input *UpdateVoiceConne // UpdateVoiceConnectorGroup API operation for Amazon Chime SDK Voice. // +// Updates the settings for the specified Amazon Chime SDK Voice Connector group. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8573,20 +9538,28 @@ func (c *ChimeSDKVoice) UpdateVoiceConnectorGroupRequest(input *UpdateVoiceConne // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup func (c *ChimeSDKVoice) UpdateVoiceConnectorGroup(input *UpdateVoiceConnectorGroupInput) (*UpdateVoiceConnectorGroupOutput, error) { @@ -8653,6 +9626,21 @@ func (c *ChimeSDKVoice) UpdateVoiceProfileRequest(input *UpdateVoiceProfileInput // UpdateVoiceProfile API operation for Amazon Chime SDK Voice. // +// Updates the specified voice profile’s voice print and refreshes its expiration +// timestamp. +// +// As a condition of using this feature, you acknowledge that the collection, +// use, storage, and retention of your caller’s biometric identifiers and +// biometric information (“biometric data”) in the form of a digital voiceprint +// requires the caller’s informed consent via a written release. Such consent +// is required under various state laws, including biometrics laws in Illinois, +// Texas, Washington and other state privacy laws. +// +// You must provide a written release to each caller through a process that +// clearly reflects each caller’s informed consent before using Amazon Chime +// SDK Voice Insights service, as required under the terms of your agreement +// with AWS governing your use of the service. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8663,24 +9651,35 @@ func (c *ChimeSDKVoice) UpdateVoiceProfileRequest(input *UpdateVoiceProfileInput // Returned Error Types: // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - NotFoundException +// The requested resource couldn't be found. // // - ConflictException +// Multiple instances of the same request were made simultaneously. // // - GoneException +// Access to the target resource is no longer available at the origin server. +// This condition is likely to be permanent. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfile func (c *ChimeSDKVoice) UpdateVoiceProfile(input *UpdateVoiceProfileInput) (*UpdateVoiceProfileOutput, error) { @@ -8747,6 +9746,8 @@ func (c *ChimeSDKVoice) UpdateVoiceProfileDomainRequest(input *UpdateVoiceProfil // UpdateVoiceProfileDomain API operation for Amazon Chime SDK Voice. // +// Updates the settings for the specified voice profile domain. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8757,20 +9758,28 @@ func (c *ChimeSDKVoice) UpdateVoiceProfileDomainRequest(input *UpdateVoiceProfil // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - AccessDeniedException +// You don't have the permissions needed to run this action. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain func (c *ChimeSDKVoice) UpdateVoiceProfileDomain(input *UpdateVoiceProfileDomainInput) (*UpdateVoiceProfileDomainOutput, error) { @@ -8837,6 +9846,12 @@ func (c *ChimeSDKVoice) ValidateE911AddressRequest(input *ValidateE911AddressInp // ValidateE911Address API operation for Amazon Chime SDK Voice. // +// Validates an address to be used for 911 calls made with Amazon Chime SDK +// Voice Connectors. You can use validated addresses in a Presence Information +// Data Format Location Object file that you include in SIP requests. That helps +// ensure that addresses are routed to the appropriate Public Safety Answering +// Point. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8847,18 +9862,25 @@ func (c *ChimeSDKVoice) ValidateE911AddressRequest(input *ValidateE911AddressInp // Returned Error Types: // // - UnauthorizedClientException +// The client isn't authorized to request a resource. // // - NotFoundException +// The requested resource couldn't be found. // // - ForbiddenException +// The client is permanently forbidden from making the request. // // - BadRequestException +// The input parameters don't match the service's restrictions. // // - ThrottledClientException +// The number of customer requests exceeds the request rate limit. // // - ServiceUnavailableException +// The service is currently unavailable. // // - ServiceFailureException +// The service encountered an unexpected error. // // See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911Address func (c *ChimeSDKVoice) ValidateE911Address(input *ValidateE911AddressInput) (*ValidateE911AddressOutput, error) { @@ -8882,6 +9904,7 @@ func (c *ChimeSDKVoice) ValidateE911AddressWithContext(ctx aws.Context, input *V return out, req.Send() } +// You don't have the permissions needed to run this action. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8945,54 +9968,76 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// A validated address. type Address struct { _ struct{} `type:"structure"` + // The city of an address. + // // City is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. City *string `locationName:"city" type:"string" sensitive:"true"` + // The country of an address. + // // Country is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. Country *string `locationName:"country" type:"string" sensitive:"true"` + // An address suffix location, such as the S. Unit A in Central Park S. Unit + // A. + // // PostDirectional is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. PostDirectional *string `locationName:"postDirectional" type:"string" sensitive:"true"` + // The postal code of an address. + // // PostalCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. PostalCode *string `locationName:"postalCode" type:"string" sensitive:"true"` + // The zip + 4 or postal code + 4 of an address. + // // PostalCodePlus4 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. PostalCodePlus4 *string `locationName:"postalCodePlus4" type:"string" sensitive:"true"` + // An address prefix location, such as the N in N. Third St. + // // PreDirectional is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. PreDirectional *string `locationName:"preDirectional" type:"string" sensitive:"true"` + // The state of an address. + // // State is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. State *string `locationName:"state" type:"string" sensitive:"true"` + // The address street, such as 8th Avenue. + // // StreetName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. StreetName *string `locationName:"streetName" type:"string" sensitive:"true"` + // The numeric portion of an address. + // // StreetNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. StreetNumber *string `locationName:"streetNumber" type:"string" sensitive:"true"` + // The address suffix, such as the N in 8th Avenue N. + // // StreetSuffix is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's // String and GoString methods. @@ -9080,11 +10125,19 @@ func (s *Address) SetStreetSuffix(v string) *Address { type AssociatePhoneNumbersWithVoiceConnectorGroupInput struct { _ struct{} `type:"structure"` + // List of phone numbers, in E.164 format. + // // E164PhoneNumbers is a required field E164PhoneNumbers []*string `type:"list" required:"true"` + // If true, associates the provided phone numbers with the provided Amazon Chime + // SDK Voice Connector Group and removes any previously existing associations. + // If false, does not associate any phone numbers that have previously existing + // associations. ForceAssociate *bool `type:"boolean"` + // The Amazon Chime SDK Voice Connector group ID. + // // VoiceConnectorGroupId is a required field VoiceConnectorGroupId *string `location:"uri" locationName:"voiceConnectorGroupId" type:"string" required:"true"` } @@ -9147,6 +10200,9 @@ func (s *AssociatePhoneNumbersWithVoiceConnectorGroupInput) SetVoiceConnectorGro type AssociatePhoneNumbersWithVoiceConnectorGroupOutput struct { _ struct{} `type:"structure"` + // If the action fails for one or more of the phone numbers in the request, + // a list of the phone numbers is returned, along with error codes and error + // messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -9177,11 +10233,19 @@ func (s *AssociatePhoneNumbersWithVoiceConnectorGroupOutput) SetPhoneNumberError type AssociatePhoneNumbersWithVoiceConnectorInput struct { _ struct{} `type:"structure"` + // List of phone numbers, in E.164 format. + // // E164PhoneNumbers is a required field E164PhoneNumbers []*string `type:"list" required:"true"` + // If true, associates the provided phone numbers with the provided Amazon Chime + // SDK Voice Connector and removes any previously existing associations. If + // false, does not associate any phone numbers that have previously existing + // associations. ForceAssociate *bool `type:"boolean"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -9244,6 +10308,9 @@ func (s *AssociatePhoneNumbersWithVoiceConnectorInput) SetVoiceConnectorId(v str type AssociatePhoneNumbersWithVoiceConnectorOutput struct { _ struct{} `type:"structure"` + // If the action fails for one or more of the phone numbers in the request, + // a list of the phone numbers is returned, along with error codes and error + // messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -9271,6 +10338,7 @@ func (s *AssociatePhoneNumbersWithVoiceConnectorOutput) SetPhoneNumberErrors(v [ return s } +// The input parameters don't match the service's restrictions. type BadRequestException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -9337,6 +10405,8 @@ func (s *BadRequestException) RequestID() string { type BatchDeletePhoneNumberInput struct { _ struct{} `type:"structure"` + // List of phone number IDs. + // // PhoneNumberIds is a required field PhoneNumberIds []*string `min:"1" type:"list" required:"true"` } @@ -9384,6 +10454,9 @@ func (s *BatchDeletePhoneNumberInput) SetPhoneNumberIds(v []*string) *BatchDelet type BatchDeletePhoneNumberOutput struct { _ struct{} `type:"structure"` + // If the action fails for one or more of the phone numbers in the request, + // a list of the phone numbers is returned, along with error codes and error + // messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -9414,6 +10487,8 @@ func (s *BatchDeletePhoneNumberOutput) SetPhoneNumberErrors(v []*PhoneNumberErro type BatchUpdatePhoneNumberInput struct { _ struct{} `type:"structure"` + // Lists the phone numbers in the update request. + // // UpdatePhoneNumberRequestItems is a required field UpdatePhoneNumberRequestItems []*UpdatePhoneNumberRequestItem `type:"list" required:"true"` } @@ -9468,6 +10543,7 @@ func (s *BatchUpdatePhoneNumberInput) SetUpdatePhoneNumberRequestItems(v []*Upda type BatchUpdatePhoneNumberOutput struct { _ struct{} `type:"structure"` + // A list of failed phone numbers and their error messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -9495,13 +10571,17 @@ func (s *BatchUpdatePhoneNumberOutput) SetPhoneNumberErrors(v []*PhoneNumberErro return s } +// The details of an Amazon Chime SDK Voice Connector call. type CallDetails struct { _ struct{} `type:"structure"` + // Identifies a person as the caller or the callee. IsCaller *bool `type:"boolean"` + // The transaction ID of a Voice Connector call. TransactionId *string `min:"1" type:"string"` + // The Voice Connector ID. VoiceConnectorId *string `min:"1" type:"string"` } @@ -9541,39 +10621,54 @@ func (s *CallDetails) SetVoiceConnectorId(v string) *CallDetails { return s } +// A suggested address. type CandidateAddress struct { _ struct{} `type:"structure"` + // The city of the candidate address. + // // City is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. City *string `locationName:"city" type:"string" sensitive:"true"` + // The country of the candidate address. + // // Country is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. Country *string `locationName:"country" type:"string" sensitive:"true"` + // The postal code of the candidate address. + // // PostalCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. PostalCode *string `locationName:"postalCode" type:"string" sensitive:"true"` + // The zip + 4 or postal code +4 of the candidate address. + // // PostalCodePlus4 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. PostalCodePlus4 *string `locationName:"postalCodePlus4" type:"string" sensitive:"true"` + // The state of the candidate address. + // // State is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. State *string `locationName:"state" type:"string" sensitive:"true"` + // The street information of the candidate address. + // // StreetInfo is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. StreetInfo *string `locationName:"streetInfo" type:"string" sensitive:"true"` + // The numeric portion of the candidate address. + // // StreetNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CandidateAddress's // String and GoString methods. @@ -9640,6 +10735,7 @@ func (s *CandidateAddress) SetStreetNumber(v string) *CandidateAddress { return s } +// Multiple instances of the same request were made simultaneously. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -9706,9 +10802,13 @@ func (s *ConflictException) RequestID() string { type CreatePhoneNumberOrderInput struct { _ struct{} `type:"structure"` + // List of phone numbers, in E.164 format. + // // E164PhoneNumbers is a required field E164PhoneNumbers []*string `type:"list" required:"true"` + // The phone number product type. + // // ProductType is a required field ProductType *string `type:"string" required:"true" enum:"PhoneNumberProductType"` } @@ -9762,6 +10862,7 @@ func (s *CreatePhoneNumberOrderInput) SetProductType(v string) *CreatePhoneNumbe type CreatePhoneNumberOrderOutput struct { _ struct{} `type:"structure"` + // The phone number order details. PhoneNumberOrder *PhoneNumberOrder `type:"structure"` } @@ -9792,25 +10893,39 @@ func (s *CreatePhoneNumberOrderOutput) SetPhoneNumberOrder(v *PhoneNumberOrder) type CreateProxySessionInput struct { _ struct{} `type:"structure"` + // The proxy session's capabilities. + // // Capabilities is a required field Capabilities []*string `type:"list" required:"true" enum:"Capability"` + // The number of minutes allowed for the proxy session. ExpiryMinutes *int64 `min:"1" type:"integer"` + // The preference for matching the country or area code of the proxy phone number + // with that of the first participant. GeoMatchLevel *string `type:"string" enum:"GeoMatchLevel"` + // The country and area code for the proxy phone number. GeoMatchParams *GeoMatchParams `type:"structure"` + // The name of the proxy session. + // // Name is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateProxySessionInput's // String and GoString methods. Name *string `type:"string" sensitive:"true"` + // The preference for proxy phone number reuse, or stickiness, between the same + // participants across sessions. NumberSelectionBehavior *string `type:"string" enum:"NumberSelectionBehavior"` + // The participant phone numbers. + // // ParticipantPhoneNumbers is a required field ParticipantPhoneNumbers []*string `min:"2" type:"list" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -9917,6 +11032,7 @@ func (s *CreateProxySessionInput) SetVoiceConnectorId(v string) *CreateProxySess type CreateProxySessionOutput struct { _ struct{} `type:"structure"` + // The proxy session details. ProxySession *ProxySession `type:"structure"` } @@ -9947,22 +11063,34 @@ func (s *CreateProxySessionOutput) SetProxySession(v *ProxySession) *CreateProxy type CreateSipMediaApplicationCallInput struct { _ struct{} `type:"structure"` + // Context passed to a CreateSipMediaApplication API call. For example, you + // could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe" ArgumentsMap map[string]*string `type:"map"` + // The phone number that a user calls from. This is a phone number in your Amazon + // Chime SDK phone number inventory. + // // FromPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateSipMediaApplicationCallInput's // String and GoString methods. + // // FromPhoneNumber is a required field FromPhoneNumber *string `type:"string" required:"true" sensitive:"true"` + // The SIP headers added to an outbound call leg. SipHeaders map[string]*string `type:"map"` + // The ID of the SIP media application. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` + // The phone number that the service should call. + // // ToPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateSipMediaApplicationCallInput's // String and GoString methods. + // // ToPhoneNumber is a required field ToPhoneNumber *string `type:"string" required:"true" sensitive:"true"` } @@ -10040,6 +11168,7 @@ func (s *CreateSipMediaApplicationCallInput) SetToPhoneNumber(v string) *CreateS type CreateSipMediaApplicationCallOutput struct { _ struct{} `type:"structure"` + // The actual call. SipMediaApplicationCall *SipMediaApplicationCall `type:"structure"` } @@ -10070,12 +11199,18 @@ func (s *CreateSipMediaApplicationCallOutput) SetSipMediaApplicationCall(v *SipM type CreateSipMediaApplicationInput struct { _ struct{} `type:"structure"` + // The AWS Region assigned to the SIP media application. + // // AwsRegion is a required field AwsRegion *string `type:"string" required:"true"` + // List of endpoints (Lambda ARNs) specified for the SIP media application. + // // Endpoints is a required field Endpoints []*SipMediaApplicationEndpoint `min:"1" type:"list" required:"true"` + // The SIP media application's name. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` } @@ -10144,6 +11279,7 @@ func (s *CreateSipMediaApplicationInput) SetName(v string) *CreateSipMediaApplic type CreateSipMediaApplicationOutput struct { _ struct{} `type:"structure"` + // The SIP media application details. SipMediaApplication *SipMediaApplication `type:"structure"` } @@ -10174,16 +11310,32 @@ func (s *CreateSipMediaApplicationOutput) SetSipMediaApplication(v *SipMediaAppl type CreateSipRuleInput struct { _ struct{} `type:"structure"` + // Disables or enables a SIP rule. You must disable SIP rules before you can + // delete them. Disabled *bool `type:"boolean"` + // The name of the SIP rule. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // List of SIP media applications, with priority and AWS Region. Only one SIP + // application per AWS Region can be used. TargetApplications []*SipRuleTargetApplication `min:"1" type:"list"` + // The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname + // or ToPhoneNumber. + // // TriggerType is a required field TriggerType *string `type:"string" required:"true" enum:"SipRuleTriggerType"` + // If TriggerType is RequestUriHostname, the value can be the outbound host + // name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can + // be a customer-owned phone number in the E164 format. The SipMediaApplication + // specified in the SipRule is triggered if the request URI in an incoming SIP + // request matches the RequestUriHostname, or if the To header in the incoming + // SIP request matches the ToPhoneNumber value. + // // TriggerValue is a required field TriggerValue *string `type:"string" required:"true"` } @@ -10274,6 +11426,7 @@ func (s *CreateSipRuleInput) SetTriggerValue(v string) *CreateSipRuleInput { type CreateSipRuleOutput struct { _ struct{} `type:"structure"` + // The SIP rule information, including the rule ID, triggers, and target applications. SipRule *SipRule `type:"structure"` } @@ -10304,9 +11457,12 @@ func (s *CreateSipRuleOutput) SetSipRule(v *SipRule) *CreateSipRuleOutput { type CreateVoiceConnectorGroupInput struct { _ struct{} `type:"structure"` + // The name of the Voice Connector group. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // Lists the Voice Connectors that inbound calls are routed to. VoiceConnectorItems []*VoiceConnectorItem `type:"list"` } @@ -10369,6 +11525,7 @@ func (s *CreateVoiceConnectorGroupInput) SetVoiceConnectorItems(v []*VoiceConnec type CreateVoiceConnectorGroupOutput struct { _ struct{} `type:"structure"` + // The details of the Voice Connector group. VoiceConnectorGroup *VoiceConnectorGroup `type:"structure"` } @@ -10399,11 +11556,17 @@ func (s *CreateVoiceConnectorGroupOutput) SetVoiceConnectorGroup(v *VoiceConnect type CreateVoiceConnectorInput struct { _ struct{} `type:"structure"` + // The AWS Region in which the Amazon Chime SDK Voice Connector is created. + // Default value: us-east-1 . AwsRegion *string `type:"string" enum:"VoiceConnectorAwsRegion"` + // The name of the Voice Connector. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // Enables or disables encryption for the Voice Connector. + // // RequireEncryption is a required field RequireEncryption *bool `type:"boolean" required:"true"` } @@ -10466,6 +11629,7 @@ func (s *CreateVoiceConnectorInput) SetRequireEncryption(v bool) *CreateVoiceCon type CreateVoiceConnectorOutput struct { _ struct{} `type:"structure"` + // The details of the Voice Connector. VoiceConnector *VoiceConnector `type:"structure"` } @@ -10496,16 +11660,24 @@ func (s *CreateVoiceConnectorOutput) SetVoiceConnector(v *VoiceConnector) *Creat type CreateVoiceProfileDomainInput struct { _ struct{} `type:"structure"` + // The unique identifier for the client request. Use a different token for different + // domain creation requests. ClientRequestToken *string `type:"string"` + // A description of the voice profile domain. Description *string `type:"string"` + // The name of the voice profile domain. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // The server-side encryption configuration for the request. + // // ServerSideEncryptionConfiguration is a required field ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"` + // The tags assigned to the domain. Tags []*Tag `min:"1" type:"list"` } @@ -10597,6 +11769,7 @@ func (s *CreateVoiceProfileDomainInput) SetTags(v []*Tag) *CreateVoiceProfileDom type CreateVoiceProfileDomainOutput struct { _ struct{} `type:"structure"` + // The requested voice profile domain. VoiceProfileDomain *VoiceProfileDomain `type:"structure"` } @@ -10627,6 +11800,8 @@ func (s *CreateVoiceProfileDomainOutput) SetVoiceProfileDomain(v *VoiceProfileDo type CreateVoiceProfileInput struct { _ struct{} `type:"structure"` + // The ID of the speaker search task. + // // SpeakerSearchTaskId is a required field SpeakerSearchTaskId *string `min:"1" type:"string" required:"true"` } @@ -10674,6 +11849,7 @@ func (s *CreateVoiceProfileInput) SetSpeakerSearchTaskId(v string) *CreateVoiceP type CreateVoiceProfileOutput struct { _ struct{} `type:"structure"` + // The requested voice profile. VoiceProfile *VoiceProfile `type:"structure"` } @@ -10701,14 +11877,22 @@ func (s *CreateVoiceProfileOutput) SetVoiceProfile(v *VoiceProfile) *CreateVoice return s } +// The SIP credentials used to authenticate requests to an Amazon Chime SDK +// Voice Connector. type Credential struct { _ struct{} `type:"structure"` + // The RFC2617 compliant password associated with the SIP credentials, in US-ASCII + // format. + // // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Credential's // String and GoString methods. Password *string `type:"string" sensitive:"true"` + // The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII + // format. + // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Credential's // String and GoString methods. @@ -10745,18 +11929,29 @@ func (s *Credential) SetUsername(v string) *Credential { return s } +// The Dialed Number Identification Service (DNIS) emergency calling configuration +// details associated with an Amazon Chime SDK Voice Connector's emergency calling +// configuration. type DNISEmergencyCallingConfiguration struct { _ struct{} `type:"structure"` + // The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 + // format. + // // CallingCountry is a required field CallingCountry *string `type:"string" required:"true"` + // The DNIS phone number that you route emergency calls to, in E.164 format. + // // EmergencyPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DNISEmergencyCallingConfiguration's // String and GoString methods. + // // EmergencyPhoneNumber is a required field EmergencyPhoneNumber *string `type:"string" required:"true" sensitive:"true"` + // The DNIS phone number for routing test emergency calls to, in E.164 format. + // // TestPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DNISEmergencyCallingConfiguration's // String and GoString methods. @@ -10818,9 +12013,12 @@ func (s *DNISEmergencyCallingConfiguration) SetTestPhoneNumber(v string) *DNISEm type DeletePhoneNumberInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The phone number ID. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DeletePhoneNumberInput's // String and GoString methods. + // // PhoneNumberId is a required field PhoneNumberId *string `location:"uri" locationName:"phoneNumberId" type:"string" required:"true" sensitive:"true"` } @@ -10890,9 +12088,13 @@ func (s DeletePhoneNumberOutput) GoString() string { type DeleteProxySessionInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The proxy session ID. + // // ProxySessionId is a required field ProxySessionId *string `location:"uri" locationName:"proxySessionId" min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -10974,6 +12176,8 @@ func (s DeleteProxySessionOutput) GoString() string { type DeleteSipMediaApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -11043,6 +12247,8 @@ func (s DeleteSipMediaApplicationOutput) GoString() string { type DeleteSipRuleInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP rule ID. + // // SipRuleId is a required field SipRuleId *string `location:"uri" locationName:"sipRuleId" type:"string" required:"true"` } @@ -11112,6 +12318,8 @@ func (s DeleteSipRuleOutput) GoString() string { type DeleteVoiceConnectorEmergencyCallingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11181,6 +12389,8 @@ func (s DeleteVoiceConnectorEmergencyCallingConfigurationOutput) GoString() stri type DeleteVoiceConnectorGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector Group ID. + // // VoiceConnectorGroupId is a required field VoiceConnectorGroupId *string `location:"uri" locationName:"voiceConnectorGroupId" type:"string" required:"true"` } @@ -11250,6 +12460,8 @@ func (s DeleteVoiceConnectorGroupOutput) GoString() string { type DeleteVoiceConnectorInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11297,6 +12509,8 @@ func (s *DeleteVoiceConnectorInput) SetVoiceConnectorId(v string) *DeleteVoiceCo type DeleteVoiceConnectorOriginationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11388,6 +12602,8 @@ func (s DeleteVoiceConnectorOutput) GoString() string { type DeleteVoiceConnectorProxyInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -11457,6 +12673,8 @@ func (s DeleteVoiceConnectorProxyOutput) GoString() string { type DeleteVoiceConnectorStreamingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11526,9 +12744,14 @@ func (s DeleteVoiceConnectorStreamingConfigurationOutput) GoString() string { type DeleteVoiceConnectorTerminationCredentialsInput struct { _ struct{} `type:"structure"` + // The RFC2617 compliant username associated with the SIP credentials, in US-ASCII + // format. + // // Usernames is a required field Usernames []*string `type:"list" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11607,6 +12830,8 @@ func (s DeleteVoiceConnectorTerminationCredentialsOutput) GoString() string { type DeleteVoiceConnectorTerminationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11676,6 +12901,8 @@ func (s DeleteVoiceConnectorTerminationOutput) GoString() string { type DeleteVoiceProfileDomainInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The voice profile domain ID. + // // VoiceProfileDomainId is a required field VoiceProfileDomainId *string `location:"uri" locationName:"VoiceProfileDomainId" min:"1" type:"string" required:"true"` } @@ -11745,6 +12972,8 @@ func (s DeleteVoiceProfileDomainOutput) GoString() string { type DeleteVoiceProfileInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The voice profile ID. + // // VoiceProfileId is a required field VoiceProfileId *string `location:"uri" locationName:"VoiceProfileId" min:"1" type:"string" required:"true"` } @@ -11814,9 +13043,13 @@ func (s DeleteVoiceProfileOutput) GoString() string { type DisassociatePhoneNumbersFromVoiceConnectorGroupInput struct { _ struct{} `type:"structure"` + // The list of phone numbers, in E.164 format. + // // E164PhoneNumbers is a required field E164PhoneNumbers []*string `type:"list" required:"true"` + // The Voice Connector group ID. + // // VoiceConnectorGroupId is a required field VoiceConnectorGroupId *string `location:"uri" locationName:"voiceConnectorGroupId" type:"string" required:"true"` } @@ -11873,6 +13106,9 @@ func (s *DisassociatePhoneNumbersFromVoiceConnectorGroupInput) SetVoiceConnector type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput struct { _ struct{} `type:"structure"` + // If the action fails for one or more of the phone numbers in the request, + // a list of the phone numbers is returned, along with error codes and error + // messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -11903,9 +13139,13 @@ func (s *DisassociatePhoneNumbersFromVoiceConnectorGroupOutput) SetPhoneNumberEr type DisassociatePhoneNumbersFromVoiceConnectorInput struct { _ struct{} `type:"structure"` + // List of phone numbers, in E.164 format. + // // E164PhoneNumbers is a required field E164PhoneNumbers []*string `type:"list" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -11962,6 +13202,9 @@ func (s *DisassociatePhoneNumbersFromVoiceConnectorInput) SetVoiceConnectorId(v type DisassociatePhoneNumbersFromVoiceConnectorOutput struct { _ struct{} `type:"structure"` + // If the action fails for one or more of the phone numbers in the request, + // a list of the phone numbers is returned, along with error codes and error + // messages. PhoneNumberErrors []*PhoneNumberError `type:"list"` } @@ -11989,9 +13232,13 @@ func (s *DisassociatePhoneNumbersFromVoiceConnectorOutput) SetPhoneNumberErrors( return s } +// The emergency calling configuration details associated with an Amazon Chime +// SDK Voice Connector. type EmergencyCallingConfiguration struct { _ struct{} `type:"structure"` + // The Dialed Number Identification Service (DNIS) emergency calling configuration + // details. DNIS []*DNISEmergencyCallingConfiguration `type:"list"` } @@ -12039,6 +13286,7 @@ func (s *EmergencyCallingConfiguration) SetDNIS(v []*DNISEmergencyCallingConfigu return s } +// The client is permanently forbidden from making the request. type ForbiddenException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -12102,12 +13350,17 @@ func (s *ForbiddenException) RequestID() string { return s.RespMetadata.RequestID } +// The country and area code for a proxy phone number in a proxy phone session. type GeoMatchParams struct { _ struct{} `type:"structure"` + // The area code. + // // AreaCode is a required field AreaCode *string `type:"string" required:"true"` + // The country. + // // Country is a required field Country *string `type:"string" required:"true"` } @@ -12183,6 +13436,7 @@ func (s GetGlobalSettingsInput) GoString() string { type GetGlobalSettingsOutput struct { _ struct{} `type:"structure"` + // The Voice Connector settings. VoiceConnector *VoiceConnectorSettings `type:"structure"` } @@ -12213,9 +13467,12 @@ func (s *GetGlobalSettingsOutput) SetVoiceConnector(v *VoiceConnectorSettings) * type GetPhoneNumberInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The phone number ID. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetPhoneNumberInput's // String and GoString methods. + // // PhoneNumberId is a required field PhoneNumberId *string `location:"uri" locationName:"phoneNumberId" type:"string" required:"true" sensitive:"true"` } @@ -12263,6 +13520,8 @@ func (s *GetPhoneNumberInput) SetPhoneNumberId(v string) *GetPhoneNumberInput { type GetPhoneNumberOrderInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The ID of the phone number order . + // // PhoneNumberOrderId is a required field PhoneNumberOrderId *string `location:"uri" locationName:"phoneNumberOrderId" type:"string" required:"true"` } @@ -12310,6 +13569,7 @@ func (s *GetPhoneNumberOrderInput) SetPhoneNumberOrderId(v string) *GetPhoneNumb type GetPhoneNumberOrderOutput struct { _ struct{} `type:"structure"` + // The phone number order details. PhoneNumberOrder *PhoneNumberOrder `type:"structure"` } @@ -12340,6 +13600,7 @@ func (s *GetPhoneNumberOrderOutput) SetPhoneNumberOrder(v *PhoneNumberOrder) *Ge type GetPhoneNumberOutput struct { _ struct{} `type:"structure"` + // The phone number details. PhoneNumber *PhoneNumber `type:"structure"` } @@ -12392,11 +13653,14 @@ func (s GetPhoneNumberSettingsInput) GoString() string { type GetPhoneNumberSettingsOutput struct { _ struct{} `type:"structure"` + // The default outbound calling name for the account. + // // CallingName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetPhoneNumberSettingsOutput's // String and GoString methods. CallingName *string `type:"string" sensitive:"true"` + // The updated outbound calling name timestamp, in ISO 8601 format. CallingNameUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -12433,9 +13697,13 @@ func (s *GetPhoneNumberSettingsOutput) SetCallingNameUpdatedTimestamp(v time.Tim type GetProxySessionInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The proxy session ID. + // // ProxySessionId is a required field ProxySessionId *string `location:"uri" locationName:"proxySessionId" min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -12495,6 +13763,7 @@ func (s *GetProxySessionInput) SetVoiceConnectorId(v string) *GetProxySessionInp type GetProxySessionOutput struct { _ struct{} `type:"structure"` + // The proxy session details. ProxySession *ProxySession `type:"structure"` } @@ -12525,6 +13794,8 @@ func (s *GetProxySessionOutput) SetProxySession(v *ProxySession) *GetProxySessio type GetSipMediaApplicationAlexaSkillConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -12572,6 +13843,7 @@ func (s *GetSipMediaApplicationAlexaSkillConfigurationInput) SetSipMediaApplicat type GetSipMediaApplicationAlexaSkillConfigurationOutput struct { _ struct{} `type:"structure"` + // Returns the Alexa Skill configuration. SipMediaApplicationAlexaSkillConfiguration *SipMediaApplicationAlexaSkillConfiguration `type:"structure"` } @@ -12602,6 +13874,8 @@ func (s *GetSipMediaApplicationAlexaSkillConfigurationOutput) SetSipMediaApplica type GetSipMediaApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP media application ID . + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -12649,6 +13923,8 @@ func (s *GetSipMediaApplicationInput) SetSipMediaApplicationId(v string) *GetSip type GetSipMediaApplicationLoggingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -12696,6 +13972,7 @@ func (s *GetSipMediaApplicationLoggingConfigurationInput) SetSipMediaApplication type GetSipMediaApplicationLoggingConfigurationOutput struct { _ struct{} `type:"structure"` + // The actual logging configuration. SipMediaApplicationLoggingConfiguration *SipMediaApplicationLoggingConfiguration `type:"structure"` } @@ -12726,6 +14003,7 @@ func (s *GetSipMediaApplicationLoggingConfigurationOutput) SetSipMediaApplicatio type GetSipMediaApplicationOutput struct { _ struct{} `type:"structure"` + // The details of the SIP media application. SipMediaApplication *SipMediaApplication `type:"structure"` } @@ -12756,6 +14034,8 @@ func (s *GetSipMediaApplicationOutput) SetSipMediaApplication(v *SipMediaApplica type GetSipRuleInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The SIP rule ID. + // // SipRuleId is a required field SipRuleId *string `location:"uri" locationName:"sipRuleId" type:"string" required:"true"` } @@ -12803,6 +14083,7 @@ func (s *GetSipRuleInput) SetSipRuleId(v string) *GetSipRuleInput { type GetSipRuleOutput struct { _ struct{} `type:"structure"` + // The SIP rule details. SipRule *SipRule `type:"structure"` } @@ -12833,9 +14114,13 @@ func (s *GetSipRuleOutput) SetSipRule(v *SipRule) *GetSipRuleOutput { type GetSpeakerSearchTaskInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The ID of the speaker search task. + // // SpeakerSearchTaskId is a required field SpeakerSearchTaskId *string `location:"uri" locationName:"SpeakerSearchTaskId" min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` } @@ -12895,6 +14180,7 @@ func (s *GetSpeakerSearchTaskInput) SetVoiceConnectorId(v string) *GetSpeakerSea type GetSpeakerSearchTaskOutput struct { _ struct{} `type:"structure"` + // The details of the speaker search task. SpeakerSearchTask *SpeakerSearchTask `type:"structure"` } @@ -12925,6 +14211,8 @@ func (s *GetSpeakerSearchTaskOutput) SetSpeakerSearchTask(v *SpeakerSearchTask) type GetVoiceConnectorEmergencyCallingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -12972,6 +14260,7 @@ func (s *GetVoiceConnectorEmergencyCallingConfigurationInput) SetVoiceConnectorI type GetVoiceConnectorEmergencyCallingConfigurationOutput struct { _ struct{} `type:"structure"` + // The details of the emergency calling configuration. EmergencyCallingConfiguration *EmergencyCallingConfiguration `type:"structure"` } @@ -13002,6 +14291,8 @@ func (s *GetVoiceConnectorEmergencyCallingConfigurationOutput) SetEmergencyCalli type GetVoiceConnectorGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector group ID. + // // VoiceConnectorGroupId is a required field VoiceConnectorGroupId *string `location:"uri" locationName:"voiceConnectorGroupId" type:"string" required:"true"` } @@ -13049,6 +14340,7 @@ func (s *GetVoiceConnectorGroupInput) SetVoiceConnectorGroupId(v string) *GetVoi type GetVoiceConnectorGroupOutput struct { _ struct{} `type:"structure"` + // The details of the Voice Connector group. VoiceConnectorGroup *VoiceConnectorGroup `type:"structure"` } @@ -13079,6 +14371,8 @@ func (s *GetVoiceConnectorGroupOutput) SetVoiceConnectorGroup(v *VoiceConnectorG type GetVoiceConnectorInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13126,6 +14420,8 @@ func (s *GetVoiceConnectorInput) SetVoiceConnectorId(v string) *GetVoiceConnecto type GetVoiceConnectorLoggingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13173,6 +14469,7 @@ func (s *GetVoiceConnectorLoggingConfigurationInput) SetVoiceConnectorId(v strin type GetVoiceConnectorLoggingConfigurationOutput struct { _ struct{} `type:"structure"` + // The logging configuration details . LoggingConfiguration *LoggingConfiguration `type:"structure"` } @@ -13203,6 +14500,8 @@ func (s *GetVoiceConnectorLoggingConfigurationOutput) SetLoggingConfiguration(v type GetVoiceConnectorOriginationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13250,6 +14549,7 @@ func (s *GetVoiceConnectorOriginationInput) SetVoiceConnectorId(v string) *GetVo type GetVoiceConnectorOriginationOutput struct { _ struct{} `type:"structure"` + // The origination setting details. Origination *Origination `type:"structure"` } @@ -13280,6 +14580,7 @@ func (s *GetVoiceConnectorOriginationOutput) SetOrigination(v *Origination) *Get type GetVoiceConnectorOutput struct { _ struct{} `type:"structure"` + // The Voice Connector details. VoiceConnector *VoiceConnector `type:"structure"` } @@ -13310,6 +14611,8 @@ func (s *GetVoiceConnectorOutput) SetVoiceConnector(v *VoiceConnector) *GetVoice type GetVoiceConnectorProxyInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -13357,6 +14660,7 @@ func (s *GetVoiceConnectorProxyInput) SetVoiceConnectorId(v string) *GetVoiceCon type GetVoiceConnectorProxyOutput struct { _ struct{} `type:"structure"` + // The proxy configuration details. Proxy *Proxy `type:"structure"` } @@ -13387,6 +14691,8 @@ func (s *GetVoiceConnectorProxyOutput) SetProxy(v *Proxy) *GetVoiceConnectorProx type GetVoiceConnectorStreamingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13434,6 +14740,7 @@ func (s *GetVoiceConnectorStreamingConfigurationInput) SetVoiceConnectorId(v str type GetVoiceConnectorStreamingConfigurationOutput struct { _ struct{} `type:"structure"` + // The details of the streaming configuration. StreamingConfiguration *StreamingConfiguration `type:"structure"` } @@ -13464,6 +14771,8 @@ func (s *GetVoiceConnectorStreamingConfigurationOutput) SetStreamingConfiguratio type GetVoiceConnectorTerminationHealthInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13511,6 +14820,7 @@ func (s *GetVoiceConnectorTerminationHealthInput) SetVoiceConnectorId(v string) type GetVoiceConnectorTerminationHealthOutput struct { _ struct{} `type:"structure"` + // The termination health details. TerminationHealth *TerminationHealth `type:"structure"` } @@ -13541,6 +14851,8 @@ func (s *GetVoiceConnectorTerminationHealthOutput) SetTerminationHealth(v *Termi type GetVoiceConnectorTerminationInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -13588,6 +14900,7 @@ func (s *GetVoiceConnectorTerminationInput) SetVoiceConnectorId(v string) *GetVo type GetVoiceConnectorTerminationOutput struct { _ struct{} `type:"structure"` + // The termination setting details. Termination *Termination `type:"structure"` } @@ -13618,6 +14931,8 @@ func (s *GetVoiceConnectorTerminationOutput) SetTermination(v *Termination) *Get type GetVoiceProfileDomainInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The voice profile domain ID. + // // VoiceProfileDomainId is a required field VoiceProfileDomainId *string `location:"uri" locationName:"VoiceProfileDomainId" min:"1" type:"string" required:"true"` } @@ -13665,6 +14980,7 @@ func (s *GetVoiceProfileDomainInput) SetVoiceProfileDomainId(v string) *GetVoice type GetVoiceProfileDomainOutput struct { _ struct{} `type:"structure"` + // The details of the voice profile domain. VoiceProfileDomain *VoiceProfileDomain `type:"structure"` } @@ -13695,6 +15011,8 @@ func (s *GetVoiceProfileDomainOutput) SetVoiceProfileDomain(v *VoiceProfileDomai type GetVoiceProfileInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The voice profile ID. + // // VoiceProfileId is a required field VoiceProfileId *string `location:"uri" locationName:"VoiceProfileId" min:"1" type:"string" required:"true"` } @@ -13742,6 +15060,7 @@ func (s *GetVoiceProfileInput) SetVoiceProfileId(v string) *GetVoiceProfileInput type GetVoiceProfileOutput struct { _ struct{} `type:"structure"` + // The voice profile details. VoiceProfile *VoiceProfile `type:"structure"` } @@ -13772,12 +15091,19 @@ func (s *GetVoiceProfileOutput) SetVoiceProfile(v *VoiceProfile) *GetVoiceProfil type GetVoiceToneAnalysisTaskInput struct { _ struct{} `type:"structure" nopayload:"true"` + // Specifies whether the voice being analyzed is the caller (originator) or + // the callee (responder). + // // IsCaller is a required field IsCaller *bool `location:"querystring" locationName:"isCaller" type:"boolean" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` + // The ID of the voice tone anlysis task. + // // VoiceToneAnalysisTaskId is a required field VoiceToneAnalysisTaskId *string `location:"uri" locationName:"VoiceToneAnalysisTaskId" min:"1" type:"string" required:"true"` } @@ -13846,6 +15172,7 @@ func (s *GetVoiceToneAnalysisTaskInput) SetVoiceToneAnalysisTaskId(v string) *Ge type GetVoiceToneAnalysisTaskOutput struct { _ struct{} `type:"structure"` + // The details of the voice tone analysis task. VoiceToneAnalysisTask *VoiceToneAnalysisTask `type:"structure"` } @@ -13873,6 +15200,8 @@ func (s *GetVoiceToneAnalysisTaskOutput) SetVoiceToneAnalysisTask(v *VoiceToneAn return s } +// Access to the target resource is no longer available at the origin server. +// This condition is likely to be permanent. type GoneException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -13961,6 +15290,7 @@ func (s ListAvailableVoiceConnectorRegionsInput) GoString() string { type ListAvailableVoiceConnectorRegionsOutput struct { _ struct{} `type:"structure"` + // The list of AWS Regions. VoiceConnectorRegions []*string `type:"list" enum:"VoiceConnectorAwsRegion"` } @@ -13991,8 +15321,10 @@ func (s *ListAvailableVoiceConnectorRegionsOutput) SetVoiceConnectorRegions(v [] type ListPhoneNumberOrdersInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to retrieve the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` } @@ -14042,8 +15374,10 @@ func (s *ListPhoneNumberOrdersInput) SetNextToken(v string) *ListPhoneNumberOrde type ListPhoneNumberOrdersOutput struct { _ struct{} `type:"structure"` + // The token used to retrieve the next page of results. NextToken *string `type:"string"` + // The phone number order details. PhoneNumberOrders []*PhoneNumberOrder `type:"list"` } @@ -14080,16 +15414,22 @@ func (s *ListPhoneNumberOrdersOutput) SetPhoneNumberOrders(v []*PhoneNumberOrder type ListPhoneNumbersInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The filter to limit the number of results. FilterName *string `location:"querystring" locationName:"filter-name" type:"string" enum:"PhoneNumberAssociationName"` + // The filter value. FilterValue *string `location:"querystring" locationName:"filter-value" type:"string"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` + // The phone number product types. ProductType *string `location:"querystring" locationName:"product-type" type:"string" enum:"PhoneNumberProductType"` + // The status of your organization's phone numbers. Status *string `location:"querystring" locationName:"status" type:"string"` } @@ -14163,8 +15503,10 @@ func (s *ListPhoneNumbersInput) SetStatus(v string) *ListPhoneNumbersInput { type ListPhoneNumbersOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The phone number details. PhoneNumbers []*PhoneNumber `type:"list"` } @@ -14201,12 +15543,17 @@ func (s *ListPhoneNumbersOutput) SetPhoneNumbers(v []*PhoneNumber) *ListPhoneNum type ListProxySessionsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to retrieve the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` + // The proxy session status. Status *string `location:"querystring" locationName:"status" type:"string" enum:"ProxySessionStatus"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -14275,8 +15622,10 @@ func (s *ListProxySessionsInput) SetVoiceConnectorId(v string) *ListProxySession type ListProxySessionsOutput struct { _ struct{} `type:"structure"` + // The token used to retrieve the next page of results. NextToken *string `type:"string"` + // The proxy sessions' details. ProxySessions []*ProxySession `type:"list"` } @@ -14313,8 +15662,10 @@ func (s *ListProxySessionsOutput) SetProxySessions(v []*ProxySession) *ListProxy type ListSipMediaApplicationsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. Defaults to 100. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` } @@ -14364,8 +15715,10 @@ func (s *ListSipMediaApplicationsInput) SetNextToken(v string) *ListSipMediaAppl type ListSipMediaApplicationsOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The list of SIP media applications and application details. SipMediaApplications []*SipMediaApplication `type:"list"` } @@ -14402,10 +15755,13 @@ func (s *ListSipMediaApplicationsOutput) SetSipMediaApplications(v []*SipMediaAp type ListSipRulesInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. Defaults to 100. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` + // The SIP media application ID. SipMediaApplicationId *string `location:"querystring" locationName:"sip-media-application" type:"string"` } @@ -14461,8 +15817,10 @@ func (s *ListSipRulesInput) SetSipMediaApplicationId(v string) *ListSipRulesInpu type ListSipRulesOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The list of SIP rules and details. SipRules []*SipRule `type:"list"` } @@ -14499,6 +15857,8 @@ func (s *ListSipRulesOutput) SetSipRules(v []*SipRule) *ListSipRulesOutput { type ListSupportedPhoneNumberCountriesInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The phone number product type. + // // ProductType is a required field ProductType *string `location:"querystring" locationName:"product-type" type:"string" required:"true" enum:"PhoneNumberProductType"` } @@ -14543,6 +15903,7 @@ func (s *ListSupportedPhoneNumberCountriesInput) SetProductType(v string) *ListS type ListSupportedPhoneNumberCountriesOutput struct { _ struct{} `type:"structure"` + // The supported phone number countries. PhoneNumberCountries []*PhoneNumberCountry `type:"list"` } @@ -14573,9 +15934,12 @@ func (s *ListSupportedPhoneNumberCountriesOutput) SetPhoneNumberCountries(v []*P type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The resource ARN. + // // ResourceARN is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ListTagsForResourceInput's // String and GoString methods. + // // ResourceARN is a required field ResourceARN *string `location:"querystring" locationName:"arn" min:"1" type:"string" required:"true" sensitive:"true"` } @@ -14623,6 +15987,7 @@ func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` + // The tags in the list. Tags []*Tag `min:"1" type:"list"` } @@ -14653,8 +16018,10 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput type ListVoiceConnectorGroupsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` } @@ -14704,8 +16071,10 @@ func (s *ListVoiceConnectorGroupsInput) SetNextToken(v string) *ListVoiceConnect type ListVoiceConnectorGroupsOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The details of the Voice Connector groups. VoiceConnectorGroups []*VoiceConnectorGroup `type:"list"` } @@ -14742,6 +16111,8 @@ func (s *ListVoiceConnectorGroupsOutput) SetVoiceConnectorGroups(v []*VoiceConne type ListVoiceConnectorTerminationCredentialsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -14789,6 +16160,7 @@ func (s *ListVoiceConnectorTerminationCredentialsInput) SetVoiceConnectorId(v st type ListVoiceConnectorTerminationCredentialsOutput struct { _ struct{} `type:"structure"` + // A list of user names. Usernames []*string `type:"list"` } @@ -14819,8 +16191,10 @@ func (s *ListVoiceConnectorTerminationCredentialsOutput) SetUsernames(v []*strin type ListVoiceConnectorsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` } @@ -14870,8 +16244,10 @@ func (s *ListVoiceConnectorsInput) SetNextToken(v string) *ListVoiceConnectorsIn type ListVoiceConnectorsOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The details of the Voice Connectors. VoiceConnectors []*VoiceConnector `type:"list"` } @@ -14908,8 +16284,10 @@ func (s *ListVoiceConnectorsOutput) SetVoiceConnectors(v []*VoiceConnector) *Lis type ListVoiceProfileDomainsInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` } @@ -14959,8 +16337,10 @@ func (s *ListVoiceProfileDomainsInput) SetNextToken(v string) *ListVoiceProfileD type ListVoiceProfileDomainsOutput struct { _ struct{} `type:"structure"` + // The token used to return the next page of results. NextToken *string `type:"string"` + // The list of voice profile domains. VoiceProfileDomains []*VoiceProfileDomainSummary `type:"list"` } @@ -14997,10 +16377,14 @@ func (s *ListVoiceProfileDomainsOutput) SetVoiceProfileDomains(v []*VoiceProfile type ListVoiceProfilesInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The maximum number of results in the request. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to retrieve the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` + // The ID of the voice profile domain. + // // VoiceProfileDomainId is a required field VoiceProfileDomainId *string `location:"querystring" locationName:"voice-profile-domain-id" min:"1" type:"string" required:"true"` } @@ -15063,8 +16447,10 @@ func (s *ListVoiceProfilesInput) SetVoiceProfileDomainId(v string) *ListVoicePro type ListVoiceProfilesOutput struct { _ struct{} `type:"structure"` + // The token used to retrieve the next page of results. NextToken *string `type:"string"` + // The list of voice profiles. VoiceProfiles []*VoiceProfileSummary `type:"list"` } @@ -15098,11 +16484,15 @@ func (s *ListVoiceProfilesOutput) SetVoiceProfiles(v []*VoiceProfileSummary) *Li return s } +// The logging configuration associated with an Amazon Chime SDK Voice Connector. +// Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs. type LoggingConfiguration struct { _ struct{} `type:"structure"` + // Enables or disables media metrics logging. EnableMediaMetricLogs *bool `type:"boolean"` + // Boolean that enables sending SIP message logs to Amazon CloudWatch logs. EnableSIPLogs *bool `type:"boolean"` } @@ -15136,14 +16526,18 @@ func (s *LoggingConfiguration) SetEnableSIPLogs(v bool) *LoggingConfiguration { return s } +// The configuration for a call analytics task. type MediaInsightsConfiguration struct { _ struct{} `type:"structure"` + // The configuration's ARN. + // // ConfigurationArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by MediaInsightsConfiguration's // String and GoString methods. ConfigurationArn *string `min:"1" type:"string" sensitive:"true"` + // Denotes the configration as enabled or disabled. Disabled *bool `type:"boolean"` } @@ -15190,6 +16584,7 @@ func (s *MediaInsightsConfiguration) SetDisabled(v bool) *MediaInsightsConfigura return s } +// The requested resource couldn't be found. type NotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -15253,14 +16648,18 @@ func (s *NotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// A phone number for which an order has been placed. type OrderedPhoneNumber struct { _ struct{} `type:"structure"` + // The phone number, in E.164 format. + // // E164PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by OrderedPhoneNumber's // String and GoString methods. E164PhoneNumber *string `type:"string" sensitive:"true"` + // The phone number status. Status *string `type:"string" enum:"OrderedPhoneNumberStatus"` } @@ -15294,11 +16693,21 @@ func (s *OrderedPhoneNumber) SetStatus(v string) *OrderedPhoneNumber { return s } +// Origination settings enable your SIP hosts to receive inbound calls using +// your Amazon Chime SDK Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type Origination struct { _ struct{} `type:"structure"` + // When origination settings are disabled, inbound calls are not enabled for + // your Amazon Chime SDK Voice Connector. This parameter is not required, but + // you must specify this parameter or Routes. Disabled *bool `type:"boolean"` + // The call distribution properties defined for your SIP hosts. Valid range: + // Minimum value of 1. Maximum value of 20. This parameter is not required, + // but you must specify this parameter or Disabled. Routes []*OriginationRoute `type:"list"` } @@ -15352,17 +16761,30 @@ func (s *Origination) SetRoutes(v []*OriginationRoute) *Origination { return s } +// Origination routes define call distribution properties for your SIP hosts +// to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: +// Ten origination routes for each Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type OriginationRoute struct { _ struct{} `type:"structure"` + // The FQDN or IP address to contact for origination traffic. Host *string `type:"string"` + // The designated origination route port. Defaults to 5060. Port *int64 `type:"integer"` + // The priority associated with the host, with 1 being the highest priority. + // Higher priority hosts are attempted first. Priority *int64 `min:"1" type:"integer"` + // The protocol to use for the origination route. Encryption-enabled Amazon + // Chime SDK Voice Connectors use TCP protocol by default. Protocol *string `type:"string" enum:"OriginationRouteProtocol"` + // The weight assigned to an origination route. When hosts have equal priority, + // calls are distributed between them based on their relative weights. Weight *int64 `min:"1" type:"integer"` } @@ -15430,14 +16852,20 @@ func (s *OriginationRoute) SetWeight(v int64) *OriginationRoute { return s } +// The phone number and proxy phone number for a participant in an Amazon Chime +// SDK Voice Connector proxy session. type Participant struct { _ struct{} `type:"structure"` + // The participant's phone number. + // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Participant's // String and GoString methods. PhoneNumber *string `type:"string" sensitive:"true"` + // The participant's proxy phone number. + // // ProxyPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Participant's // String and GoString methods. @@ -15474,44 +16902,62 @@ func (s *Participant) SetProxyPhoneNumber(v string) *Participant { return s } +// A phone number used to call an Amazon Chime SDK Voice Connector. type PhoneNumber struct { _ struct{} `type:"structure"` + // The phone number's associations. Associations []*PhoneNumberAssociation `type:"list"` + // The outbound calling name associated with the phone number. + // // CallingName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumber's // String and GoString methods. CallingName *string `type:"string" sensitive:"true"` + // The outbound calling name status. CallingNameStatus *string `type:"string" enum:"CallingNameStatus"` + // The phone number's capabilities. Capabilities *PhoneNumberCapabilities `type:"structure"` + // The phone number's country. Format: ISO 3166-1 alpha-2. Country *string `type:"string"` + // The phone number creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The deleted phone number timestamp, in ISO 8601 format. DeletionTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The phone number, in E.164 format. + // // E164PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumber's // String and GoString methods. E164PhoneNumber *string `type:"string" sensitive:"true"` + // The phone number's order ID. OrderId *string `type:"string"` + // The phone number's ID. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumber's // String and GoString methods. PhoneNumberId *string `type:"string" sensitive:"true"` + // The phone number's product type. ProductType *string `type:"string" enum:"PhoneNumberProductType"` + // The phone number's status. Status *string `type:"string" enum:"PhoneNumberStatus"` + // The phone number's type. Type *string `type:"string" enum:"PhoneNumberType"` + // The updated phone number timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -15617,13 +17063,19 @@ func (s *PhoneNumber) SetUpdatedTimestamp(v time.Time) *PhoneNumber { return s } +// The phone number associations, such as an Amazon Chime SDK account ID, user +// ID, Voice Connector ID, or Voice Connector group ID. type PhoneNumberAssociation struct { _ struct{} `type:"structure"` + // The timestamp of the phone number association, in ISO 8601 format. AssociatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // Defines the association with an Amazon Chime SDK account ID, user ID, Voice + // Connector ID, or Voice Connector group ID. Name *string `type:"string" enum:"PhoneNumberAssociationName"` + // Contains the ID for the entity specified in Name. Value *string `type:"string"` } @@ -15663,19 +17115,27 @@ func (s *PhoneNumberAssociation) SetValue(v string) *PhoneNumberAssociation { return s } +// The phone number capabilities for Amazon Chime SDK phone numbers, such as +// enabled inbound and outbound calling, and text messaging. type PhoneNumberCapabilities struct { _ struct{} `type:"structure"` + // Allows or denies inbound calling for the specified phone number. InboundCall *bool `type:"boolean"` + // Allows or denies inbound MMS messaging for the specified phone number. InboundMMS *bool `type:"boolean"` + // Allows or denies inbound SMS messaging for the specified phone number. InboundSMS *bool `type:"boolean"` + // Allows or denies outbound calling for the specified phone number. OutboundCall *bool `type:"boolean"` + // Allows or denies inbound MMS messaging for the specified phone number. OutboundMMS *bool `type:"boolean"` + // Allows or denies outbound SMS messaging for the specified phone number. OutboundSMS *bool `type:"boolean"` } @@ -15733,11 +17193,14 @@ func (s *PhoneNumberCapabilities) SetOutboundSMS(v bool) *PhoneNumberCapabilitie return s } +// The phone number's country. type PhoneNumberCountry struct { _ struct{} `type:"structure"` + // The phone number country code. Format: ISO 3166-1 alpha-2. CountryCode *string `type:"string"` + // The supported phone number types. SupportedPhoneNumberTypes []*string `type:"list" enum:"PhoneNumberType"` } @@ -15771,13 +17234,20 @@ func (s *PhoneNumberCountry) SetSupportedPhoneNumberTypes(v []*string) *PhoneNum return s } +// If a phone number action fails for one or more of the phone numbers in a +// request, a list of the failed phone numbers is returned, along with error +// codes and error messages. type PhoneNumberError struct { _ struct{} `type:"structure"` + // The error code. ErrorCode *string `type:"string" enum:"ErrorCode"` + // The error message. ErrorMessage *string `type:"string"` + // The phone number ID for which the action failed. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumberError's // String and GoString methods. @@ -15820,21 +17290,30 @@ func (s *PhoneNumberError) SetPhoneNumberId(v string) *PhoneNumberError { return s } +// The details of an Amazon Chime SDK phone number order. type PhoneNumberOrder struct { _ struct{} `type:"structure"` + // The phone number order creation time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The type of phone number being ordered, local or toll-free. OrderType *string `type:"string" enum:"PhoneNumberOrderType"` + // The ordered phone number details, such as the phone number in E.164 format + // and the phone number status. OrderedPhoneNumbers []*OrderedPhoneNumber `type:"list"` + // The ID of the phone order. PhoneNumberOrderId *string `type:"string"` + // The phone number order product type. ProductType *string `type:"string" enum:"PhoneNumberProductType"` + // The status of the phone number order. Status *string `type:"string" enum:"PhoneNumberOrderStatus"` + // The updated phone number order time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -15898,18 +17377,25 @@ func (s *PhoneNumberOrder) SetUpdatedTimestamp(v time.Time) *PhoneNumberOrder { return s } +// The proxy configuration for an Amazon Chime SDK Voice Connector. type Proxy struct { _ struct{} `type:"structure"` + // The default number of minutes allowed for proxy sessions. DefaultSessionExpiryMinutes *int64 `type:"integer"` + // When true, stops proxy sessions from being created on the specified Amazon + // Chime SDK Voice Connector. Disabled *bool `type:"boolean"` + // The phone number to route calls to after a proxy session expires. + // // FallBackPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Proxy's // String and GoString methods. FallBackPhoneNumber *string `type:"string" sensitive:"true"` + // The countries for proxy phone numbers to be selected from. PhoneNumberCountries []*string `type:"list"` } @@ -15955,33 +17441,49 @@ func (s *Proxy) SetPhoneNumberCountries(v []*string) *Proxy { return s } +// The proxy session for an Amazon Chime SDK Voice Connector. type ProxySession struct { _ struct{} `type:"structure"` + // The proxy session capabilities. Capabilities []*string `type:"list" enum:"Capability"` + // The created time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ended time stamp, in ISO 8601 format. EndedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The number of minutes allowed for the proxy session. ExpiryMinutes *int64 `min:"1" type:"integer"` + // The preference for matching the country or area code of the proxy phone number + // with that of the first participant. GeoMatchLevel *string `type:"string" enum:"GeoMatchLevel"` + // The country and area code for the proxy phone number. GeoMatchParams *GeoMatchParams `type:"structure"` + // The proxy session name. Name *string `type:"string"` + // The preference for proxy phone number reuse, or stickiness, between the same + // participants across sessions. NumberSelectionBehavior *string `type:"string" enum:"NumberSelectionBehavior"` + // The proxy session participants. Participants []*Participant `type:"list"` + // The proxy session ID. ProxySessionId *string `min:"1" type:"string"` + // The proxy session status. Status *string `type:"string" enum:"ProxySessionStatus"` + // The updated time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The Voice Connector ID. VoiceConnectorId *string `min:"1" type:"string"` } @@ -16084,8 +17586,11 @@ func (s *ProxySession) SetVoiceConnectorId(v string) *ProxySession { type PutSipMediaApplicationAlexaSkillConfigurationInput struct { _ struct{} `type:"structure"` + // The Alexa Skill configuration. SipMediaApplicationAlexaSkillConfiguration *SipMediaApplicationAlexaSkillConfiguration `type:"structure"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -16144,6 +17649,7 @@ func (s *PutSipMediaApplicationAlexaSkillConfigurationInput) SetSipMediaApplicat type PutSipMediaApplicationAlexaSkillConfigurationOutput struct { _ struct{} `type:"structure"` + // Returns the Alexa Skill configuration. SipMediaApplicationAlexaSkillConfiguration *SipMediaApplicationAlexaSkillConfiguration `type:"structure"` } @@ -16174,9 +17680,12 @@ func (s *PutSipMediaApplicationAlexaSkillConfigurationOutput) SetSipMediaApplica type PutSipMediaApplicationLoggingConfigurationInput struct { _ struct{} `type:"structure"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` + // The logging configuration for the specified SIP media application. SipMediaApplicationLoggingConfiguration *SipMediaApplicationLoggingConfiguration `type:"structure"` } @@ -16229,6 +17738,7 @@ func (s *PutSipMediaApplicationLoggingConfigurationInput) SetSipMediaApplication type PutSipMediaApplicationLoggingConfigurationOutput struct { _ struct{} `type:"structure"` + // The updated logging configuration for the specified SIP media application. SipMediaApplicationLoggingConfiguration *SipMediaApplicationLoggingConfiguration `type:"structure"` } @@ -16259,9 +17769,13 @@ func (s *PutSipMediaApplicationLoggingConfigurationOutput) SetSipMediaApplicatio type PutVoiceConnectorEmergencyCallingConfigurationInput struct { _ struct{} `type:"structure"` + // The configuration being updated. + // // EmergencyCallingConfiguration is a required field EmergencyCallingConfiguration *EmergencyCallingConfiguration `type:"structure" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16323,6 +17837,7 @@ func (s *PutVoiceConnectorEmergencyCallingConfigurationInput) SetVoiceConnectorI type PutVoiceConnectorEmergencyCallingConfigurationOutput struct { _ struct{} `type:"structure"` + // The updated configuration. EmergencyCallingConfiguration *EmergencyCallingConfiguration `type:"structure"` } @@ -16353,9 +17868,13 @@ func (s *PutVoiceConnectorEmergencyCallingConfigurationOutput) SetEmergencyCalli type PutVoiceConnectorLoggingConfigurationInput struct { _ struct{} `type:"structure"` + // The logging configuration being updated. + // // LoggingConfiguration is a required field LoggingConfiguration *LoggingConfiguration `type:"structure" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16412,6 +17931,7 @@ func (s *PutVoiceConnectorLoggingConfigurationInput) SetVoiceConnectorId(v strin type PutVoiceConnectorLoggingConfigurationOutput struct { _ struct{} `type:"structure"` + // The updated logging configuration. LoggingConfiguration *LoggingConfiguration `type:"structure"` } @@ -16442,9 +17962,13 @@ func (s *PutVoiceConnectorLoggingConfigurationOutput) SetLoggingConfiguration(v type PutVoiceConnectorOriginationInput struct { _ struct{} `type:"structure"` + // The origination settings being updated. + // // Origination is a required field Origination *Origination `type:"structure" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16506,6 +18030,7 @@ func (s *PutVoiceConnectorOriginationInput) SetVoiceConnectorId(v string) *PutVo type PutVoiceConnectorOriginationOutput struct { _ struct{} `type:"structure"` + // The updated origination settings. Origination *Origination `type:"structure"` } @@ -16536,19 +18061,29 @@ func (s *PutVoiceConnectorOriginationOutput) SetOrigination(v *Origination) *Put type PutVoiceConnectorProxyInput struct { _ struct{} `type:"structure"` + // The default number of minutes allowed for proxy session. + // // DefaultSessionExpiryMinutes is a required field DefaultSessionExpiryMinutes *int64 `type:"integer" required:"true"` + // When true, stops proxy sessions from being created on the specified Amazon + // Chime SDK Voice Connector. Disabled *bool `type:"boolean"` + // The phone number to route calls to after a proxy session expires. + // // FallBackPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutVoiceConnectorProxyInput's // String and GoString methods. FallBackPhoneNumber *string `type:"string" sensitive:"true"` + // The countries for proxy phone numbers to be selected from. + // // PhoneNumberPoolCountries is a required field PhoneNumberPoolCountries []*string `min:"1" type:"list" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -16629,6 +18164,7 @@ func (s *PutVoiceConnectorProxyInput) SetVoiceConnectorId(v string) *PutVoiceCon type PutVoiceConnectorProxyOutput struct { _ struct{} `type:"structure"` + // The proxy configuration details. Proxy *Proxy `type:"structure"` } @@ -16659,9 +18195,13 @@ func (s *PutVoiceConnectorProxyOutput) SetProxy(v *Proxy) *PutVoiceConnectorProx type PutVoiceConnectorStreamingConfigurationInput struct { _ struct{} `type:"structure"` + // The streaming settings being updated. + // // StreamingConfiguration is a required field StreamingConfiguration *StreamingConfiguration `type:"structure" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16723,6 +18263,7 @@ func (s *PutVoiceConnectorStreamingConfigurationInput) SetVoiceConnectorId(v str type PutVoiceConnectorStreamingConfigurationOutput struct { _ struct{} `type:"structure"` + // The updated streaming settings. StreamingConfiguration *StreamingConfiguration `type:"structure"` } @@ -16753,8 +18294,11 @@ func (s *PutVoiceConnectorStreamingConfigurationOutput) SetStreamingConfiguratio type PutVoiceConnectorTerminationCredentialsInput struct { _ struct{} `type:"structure"` + // The termination credentials being updated. Credentials []*Credential `type:"list"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16830,9 +18374,13 @@ func (s PutVoiceConnectorTerminationCredentialsOutput) GoString() string { type PutVoiceConnectorTerminationInput struct { _ struct{} `type:"structure"` + // The termination settings to be updated. + // // Termination is a required field Termination *Termination `type:"structure" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -16894,6 +18442,7 @@ func (s *PutVoiceConnectorTerminationInput) SetVoiceConnectorId(v string) *PutVo type PutVoiceConnectorTerminationOutput struct { _ struct{} `type:"structure"` + // The updated termination settings. Termination *Termination `type:"structure"` } @@ -16921,6 +18470,7 @@ func (s *PutVoiceConnectorTerminationOutput) SetTermination(v *Termination) *Put return s } +// The request exceeds the resource limit. type ResourceLimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -16987,9 +18537,12 @@ func (s *ResourceLimitExceededException) RequestID() string { type RestorePhoneNumberInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The ID of the phone number being restored. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RestorePhoneNumberInput's // String and GoString methods. + // // PhoneNumberId is a required field PhoneNumberId *string `location:"uri" locationName:"phoneNumberId" type:"string" required:"true" sensitive:"true"` } @@ -17037,6 +18590,7 @@ func (s *RestorePhoneNumberInput) SetPhoneNumberId(v string) *RestorePhoneNumber type RestorePhoneNumberOutput struct { _ struct{} `type:"structure"` + // The restored phone number. PhoneNumber *PhoneNumber `type:"structure"` } @@ -17067,20 +18621,34 @@ func (s *RestorePhoneNumberOutput) SetPhoneNumber(v *PhoneNumber) *RestorePhoneN type SearchAvailablePhoneNumbersInput struct { _ struct{} `type:"structure" nopayload:"true"` + // Confines a search to just the phone numbers associated with the specified + // area code. AreaCode *string `location:"querystring" locationName:"area-code" type:"string"` + // Confines a search to just the phone numbers associated with the specified + // city. City *string `location:"querystring" locationName:"city" type:"string"` + // Confines a search to just the phone numbers associated with the specified + // country. Country *string `location:"querystring" locationName:"country" type:"string"` + // The maximum number of results to return. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + // The token used to return the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` + // Confines a search to just the phone numbers associated with the specified + // phone number type, either local or toll-free. PhoneNumberType *string `location:"querystring" locationName:"phone-number-type" type:"string" enum:"PhoneNumberType"` + // Confines a search to just the phone numbers associated with the specified + // state. State *string `location:"querystring" locationName:"state" type:"string"` + // Confines a search to just the phone numbers associated with the specified + // toll-free prefix. TollFreePrefix *string `location:"querystring" locationName:"toll-free-prefix" min:"3" type:"string"` } @@ -17169,8 +18737,10 @@ func (s *SearchAvailablePhoneNumbersInput) SetTollFreePrefix(v string) *SearchAv type SearchAvailablePhoneNumbersOutput struct { _ struct{} `type:"structure"` + // Confines a search to just the phone numbers in the E.164 format. E164PhoneNumbers []*string `type:"list"` + // The token used to return the next page of results. NextToken *string `type:"string"` } @@ -17204,12 +18774,20 @@ func (s *SearchAvailablePhoneNumbersOutput) SetNextToken(v string) *SearchAvaila return s } +// A structure that contains the configuration settings for server-side encryption. +// +// We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS +// aliases. type ServerSideEncryptionConfiguration struct { _ struct{} `type:"structure"` + // The ARN of the KMS key used to encrypt the enrollment data in a voice profile + // domain. Asymmetric customer managed keys are not supported. + // // KmsKeyArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ServerSideEncryptionConfiguration's // String and GoString methods. + // // KmsKeyArn is a required field KmsKeyArn *string `min:"1" type:"string" required:"true" sensitive:"true"` } @@ -17254,6 +18832,7 @@ func (s *ServerSideEncryptionConfiguration) SetKmsKeyArn(v string) *ServerSideEn return s } +// The service encountered an unexpected error. type ServiceFailureException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -17317,6 +18896,7 @@ func (s *ServiceFailureException) RequestID() string { return s.RespMetadata.RequestID } +// The service is currently unavailable. type ServiceUnavailableException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -17380,19 +18960,28 @@ func (s *ServiceUnavailableException) RequestID() string { return s.RespMetadata.RequestID } +// The details of the SIP media application, including name and endpoints. An +// AWS account can have multiple SIP media applications. type SipMediaApplication struct { _ struct{} `type:"structure"` + // The AWS Region in which the SIP media application is created. AwsRegion *string `type:"string"` + // The SIP media application creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // List of endpoints for SIP media application. Currently, only one endpoint + // per SIP media application is permitted. Endpoints []*SipMediaApplicationEndpoint `min:"1" type:"list"` + // The SIP media application's name. Name *string `min:"1" type:"string"` + // A SIP media application's ID. SipMediaApplicationId *string `type:"string"` + // The time at which the SIP media application was updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -17450,12 +19039,17 @@ func (s *SipMediaApplication) SetUpdatedTimestamp(v time.Time) *SipMediaApplicat return s } +// The Alexa Skill configuration of a SIP media application. type SipMediaApplicationAlexaSkillConfiguration struct { _ struct{} `type:"structure"` + // The ID of the Alexa Skill configuration. + // // AlexaSkillIds is a required field AlexaSkillIds []*string `min:"1" type:"list" required:"true"` + // The status of the Alexa Skill configuration. + // // AlexaSkillStatus is a required field AlexaSkillStatus *string `type:"string" required:"true" enum:"AlexaSkillStatus"` } @@ -17509,9 +19103,11 @@ func (s *SipMediaApplicationAlexaSkillConfiguration) SetAlexaSkillStatus(v strin return s } +// A Call instance for a SIP media application. type SipMediaApplicationCall struct { _ struct{} `type:"structure"` + // The call's transaction ID. TransactionId *string `type:"string"` } @@ -17539,9 +19135,13 @@ func (s *SipMediaApplicationCall) SetTransactionId(v string) *SipMediaApplicatio return s } +// The endpoint assigned to a SIP media application. type SipMediaApplicationEndpoint struct { _ struct{} `type:"structure"` + // Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. + // The function must be created in the same AWS Region as the SIP media application. + // // LambdaArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SipMediaApplicationEndpoint's // String and GoString methods. @@ -17572,9 +19172,11 @@ func (s *SipMediaApplicationEndpoint) SetLambdaArn(v string) *SipMediaApplicatio return s } +// The logging configuration of a SIP media application. type SipMediaApplicationLoggingConfiguration struct { _ struct{} `type:"structure"` + // Enables message logging for the specified SIP media application. EnableSipMediaApplicationMessageLogs *bool `type:"boolean"` } @@ -17602,23 +19204,38 @@ func (s *SipMediaApplicationLoggingConfiguration) SetEnableSipMediaApplicationMe return s } +// The details of a SIP rule, including name, triggers, and target applications. +// An AWS account can have multiple SIP rules. type SipRule struct { _ struct{} `type:"structure"` + // The time at which the SIP rule was created, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // Indicates whether the SIP rule is enabled or disabled. You must disable a + // rule before you can delete it. Disabled *bool `type:"boolean"` + // A SIP rule's name. Name *string `min:"1" type:"string"` + // A SIP rule's ID. SipRuleId *string `type:"string"` + // The target SIP media application and other details, such as priority and + // AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region + // can be provided. TargetApplications []*SipRuleTargetApplication `min:"1" type:"list"` + // The type of trigger set for a SIP rule, either a phone number or a URI request + // host name. TriggerType *string `type:"string" enum:"SipRuleTriggerType"` + // The value set for a SIP rule's trigger type. Either a phone number or a URI + // hostname. TriggerValue *string `type:"string"` + // The time at which the SIP rule was updated, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -17688,13 +19305,19 @@ func (s *SipRule) SetUpdatedTimestamp(v time.Time) *SipRule { return s } +// A target SIP media application and other details, such as priority and AWS +// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region +// can be provided. type SipRuleTargetApplication struct { _ struct{} `type:"structure"` + // The AWS Region of a rule's target SIP media application. AwsRegion *string `type:"string"` + // The priority setting of a rule's target SIP media application. Priority *int64 `min:"1" type:"integer"` + // The ID of a rule's target SIP media application. SipMediaApplicationId *string `type:"string"` } @@ -17747,11 +19370,15 @@ func (s *SipRuleTargetApplication) SetSipMediaApplicationId(v string) *SipRuleTa return s } +// The details of a speaker search task. type SpeakerSearchDetails struct { _ struct{} `type:"structure"` + // The result value in the speaker search details. Results []*SpeakerSearchResult `type:"list"` + // The status of a voice print generation operation, VoiceprintGenerationSuccess + // or VoiceprintGenerationFailure.. VoiceprintGenerationStatus *string `min:"1" type:"string"` } @@ -17785,11 +19412,14 @@ func (s *SpeakerSearchDetails) SetVoiceprintGenerationStatus(v string) *SpeakerS return s } +// The result of a speaker search analysis. type SpeakerSearchResult struct { _ struct{} `type:"structure"` + // The confidence score in the speaker search analysis. ConfidenceScore *float64 `type:"float"` + // The voice profile ID. VoiceProfileId *string `min:"1" type:"string"` } @@ -17823,23 +19453,34 @@ func (s *SpeakerSearchResult) SetVoiceProfileId(v string) *SpeakerSearchResult { return s } +// A representation of an asynchronous request to perform speaker search analysis +// on a Voice Connector call. type SpeakerSearchTask struct { _ struct{} `type:"structure"` + // The call details of a speaker search task. CallDetails *CallDetails `type:"structure"` + // The time at which a speaker search task was created. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The details of a speaker search task. SpeakerSearchDetails *SpeakerSearchDetails `type:"structure"` + // The speaker search task ID. SpeakerSearchTaskId *string `min:"1" type:"string"` + // The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, + // SUCCEEDED, FAILED, or STOPPED. SpeakerSearchTaskStatus *string `type:"string"` + // The time at which the speaker search task began. StartedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // A detailed message about the status of a speaker search. StatusMessage *string `type:"string"` + // The time at which a speaker search task was updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -17912,14 +19553,22 @@ func (s *SpeakerSearchTask) SetUpdatedTimestamp(v time.Time) *SpeakerSearchTask type StartSpeakerSearchTaskInput struct { _ struct{} `type:"structure"` + // The unique identifier for the client request. Use a different token for different + // speaker search tasks. ClientRequestToken *string `type:"string"` + // The transaction ID of the call being analyzed. + // // TransactionId is a required field TransactionId *string `min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` + // The ID of the voice profile domain that will store the voice profile. + // // VoiceProfileDomainId is a required field VoiceProfileDomainId *string `min:"1" type:"string" required:"true"` } @@ -17997,6 +19646,7 @@ func (s *StartSpeakerSearchTaskInput) SetVoiceProfileDomainId(v string) *StartSp type StartSpeakerSearchTaskOutput struct { _ struct{} `type:"structure"` + // The details of the speaker search task. SpeakerSearchTask *SpeakerSearchTask `type:"structure"` } @@ -18027,14 +19677,22 @@ func (s *StartSpeakerSearchTaskOutput) SetSpeakerSearchTask(v *SpeakerSearchTask type StartVoiceToneAnalysisTaskInput struct { _ struct{} `type:"structure"` + // The unique identifier for the client request. Use a different token for different + // voice tone analysis tasks. ClientRequestToken *string `type:"string"` + // The language code. + // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + // The transaction ID. + // // TransactionId is a required field TransactionId *string `min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` } @@ -18109,6 +19767,7 @@ func (s *StartVoiceToneAnalysisTaskInput) SetVoiceConnectorId(v string) *StartVo type StartVoiceToneAnalysisTaskOutput struct { _ struct{} `type:"structure"` + // The details of the voice tone analysis task. VoiceToneAnalysisTask *VoiceToneAnalysisTask `type:"structure"` } @@ -18139,9 +19798,13 @@ func (s *StartVoiceToneAnalysisTaskOutput) SetVoiceToneAnalysisTask(v *VoiceTone type StopSpeakerSearchTaskInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The speaker search task ID. + // // SpeakerSearchTaskId is a required field SpeakerSearchTaskId *string `location:"uri" locationName:"SpeakerSearchTaskId" min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` } @@ -18223,9 +19886,13 @@ func (s StopSpeakerSearchTaskOutput) GoString() string { type StopVoiceToneAnalysisTaskInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"VoiceConnectorId" min:"1" type:"string" required:"true"` + // The ID of the voice tone analysis task. + // // VoiceToneAnalysisTaskId is a required field VoiceToneAnalysisTaskId *string `location:"uri" locationName:"VoiceToneAnalysisTaskId" min:"1" type:"string" required:"true"` } @@ -18304,17 +19971,26 @@ func (s StopVoiceToneAnalysisTaskOutput) GoString() string { return s.String() } +// The streaming configuration associated with an Amazon Chime SDK Voice Connector. +// Specifies whether media streaming is enabled for sending to Amazon Kinesis, +// and shows the retention period for the Amazon Kinesis data, in hours. type StreamingConfiguration struct { _ struct{} `type:"structure"` + // The amount of time, in hours, to the Kinesis data. + // // DataRetentionInHours is a required field DataRetentionInHours *int64 `type:"integer" required:"true"` + // When true, streaming to Kinesis is off. + // // Disabled is a required field Disabled *bool `type:"boolean" required:"true"` + // The call analytics configuration. MediaInsightsConfiguration *MediaInsightsConfiguration `type:"structure"` + // The streaming notification targets. StreamingNotificationTargets []*StreamingNotificationTarget `min:"1" type:"list"` } @@ -18384,9 +20060,11 @@ func (s *StreamingConfiguration) SetStreamingNotificationTargets(v []*StreamingN return s } +// The target recipient for a streaming configuration notification. type StreamingNotificationTarget struct { _ struct{} `type:"structure"` + // The streaming notification target. NotificationTarget *string `type:"string" enum:"NotificationTarget"` } @@ -18414,18 +20092,25 @@ func (s *StreamingNotificationTarget) SetNotificationTarget(v string) *Streaming return s } +// Describes a tag applied to a resource. type Tag struct { _ struct{} `type:"structure"` + // The tag's key. + // // Key is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Tag's // String and GoString methods. + // // Key is a required field Key *string `min:"1" type:"string" required:"true" sensitive:"true"` + // The tag's value. + // // Value is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Tag's // String and GoString methods. + // // Value is a required field Value *string `type:"string" required:"true" sensitive:"true"` } @@ -18482,12 +20167,17 @@ func (s *Tag) SetValue(v string) *Tag { type TagResourceInput struct { _ struct{} `type:"structure"` + // The ARN of the resource being tagged. + // // ResourceARN is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by TagResourceInput's // String and GoString methods. + // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true" sensitive:"true"` + // A list of the tags being added to the resource. + // // Tags is a required field Tags []*Tag `min:"1" type:"list" required:"true"` } @@ -18576,20 +20266,29 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// Termination settings enable SIP hosts to make outbound calls using an Amazon +// Chime SDK Voice Connector. type Termination struct { _ struct{} `type:"structure"` + // The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required. CallingRegions []*string `type:"list"` + // The IP addresses allowed to make calls, in CIDR format. CidrAllowedList []*string `type:"list"` + // The limit on calls per second. Max value based on account service quota. + // Default value of 1. CpsLimit *int64 `min:"1" type:"integer"` + // The default outbound calling number. + // // DefaultPhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Termination's // String and GoString methods. DefaultPhoneNumber *string `type:"string" sensitive:"true"` + // When termination is disabled, outbound calls cannot be made. Disabled *bool `type:"boolean"` } @@ -18654,11 +20353,15 @@ func (s *Termination) SetDisabled(v bool) *Termination { return s } +// The termination health details, including the source IP address and timestamp +// of the last successful SIP OPTIONS message from your SIP infrastructure. type TerminationHealth struct { _ struct{} `type:"structure"` + // The source IP address. Source *string `type:"string"` + // The timestamp, in ISO 8601 format. Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -18692,6 +20395,7 @@ func (s *TerminationHealth) SetTimestamp(v time.Time) *TerminationHealth { return s } +// The number of customer requests exceeds the request rate limit. type ThrottledClientException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18755,6 +20459,7 @@ func (s *ThrottledClientException) RequestID() string { return s.RespMetadata.RequestID } +// The client isn't authorized to request a resource. type UnauthorizedClientException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18818,6 +20523,7 @@ func (s *UnauthorizedClientException) RequestID() string { return s.RespMetadata.RequestID } +// A well-formed request couldn't be followed due to semantic errors. type UnprocessableEntityException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18884,12 +20590,17 @@ func (s *UnprocessableEntityException) RequestID() string { type UntagResourceInput struct { _ struct{} `type:"structure"` + // The ARN of the resource having its tags removed. + // // ResourceARN is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UntagResourceInput's // String and GoString methods. + // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true" sensitive:"true"` + // The keys of the tags being removed from the resource. + // // TagKeys is a required field TagKeys []*string `min:"1" type:"list" required:"true"` } @@ -18971,6 +20682,7 @@ func (s UntagResourceOutput) GoString() string { type UpdateGlobalSettingsInput struct { _ struct{} `type:"structure"` + // The Voice Connector settings. VoiceConnector *VoiceConnectorSettings `type:"structure"` } @@ -19023,17 +20735,23 @@ func (s UpdateGlobalSettingsOutput) GoString() string { type UpdatePhoneNumberInput struct { _ struct{} `type:"structure"` + // The outbound calling name associated with the phone number. + // // CallingName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdatePhoneNumberInput's // String and GoString methods. CallingName *string `type:"string" sensitive:"true"` + // The phone number ID. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdatePhoneNumberInput's // String and GoString methods. + // // PhoneNumberId is a required field PhoneNumberId *string `location:"uri" locationName:"phoneNumberId" type:"string" required:"true" sensitive:"true"` + // The product type. ProductType *string `type:"string" enum:"PhoneNumberProductType"` } @@ -19092,6 +20810,7 @@ func (s *UpdatePhoneNumberInput) SetProductType(v string) *UpdatePhoneNumberInpu type UpdatePhoneNumberOutput struct { _ struct{} `type:"structure"` + // The updated phone number details. PhoneNumber *PhoneNumber `type:"structure"` } @@ -19119,20 +20838,28 @@ func (s *UpdatePhoneNumberOutput) SetPhoneNumber(v *PhoneNumber) *UpdatePhoneNum return s } +// The phone number ID, product type, or calling name fields to update, used +// with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. type UpdatePhoneNumberRequestItem struct { _ struct{} `type:"structure"` + // The outbound calling name to update. + // // CallingName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdatePhoneNumberRequestItem's // String and GoString methods. CallingName *string `type:"string" sensitive:"true"` + // The phone number ID to update. + // // PhoneNumberId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdatePhoneNumberRequestItem's // String and GoString methods. + // // PhoneNumberId is a required field PhoneNumberId *string `type:"string" required:"true" sensitive:"true"` + // The product type to update. ProductType *string `type:"string" enum:"PhoneNumberProductType"` } @@ -19188,9 +20915,12 @@ func (s *UpdatePhoneNumberRequestItem) SetProductType(v string) *UpdatePhoneNumb type UpdatePhoneNumberSettingsInput struct { _ struct{} `type:"structure"` + // The default outbound calling name for the account. + // // CallingName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdatePhoneNumberSettingsInput's // String and GoString methods. + // // CallingName is a required field CallingName *string `type:"string" required:"true" sensitive:"true"` } @@ -19257,14 +20987,21 @@ func (s UpdatePhoneNumberSettingsOutput) GoString() string { type UpdateProxySessionInput struct { _ struct{} `type:"structure"` + // The proxy session capabilities. + // // Capabilities is a required field Capabilities []*string `type:"list" required:"true" enum:"Capability"` + // The number of minutes allowed for the proxy session. ExpiryMinutes *int64 `min:"1" type:"integer"` + // The proxy session ID. + // // ProxySessionId is a required field ProxySessionId *string `location:"uri" locationName:"proxySessionId" min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" min:"1" type:"string" required:"true"` } @@ -19342,6 +21079,7 @@ func (s *UpdateProxySessionInput) SetVoiceConnectorId(v string) *UpdateProxySess type UpdateProxySessionOutput struct { _ struct{} `type:"structure"` + // The updated proxy session details. ProxySession *ProxySession `type:"structure"` } @@ -19372,12 +21110,19 @@ func (s *UpdateProxySessionOutput) SetProxySession(v *ProxySession) *UpdateProxy type UpdateSipMediaApplicationCallInput struct { _ struct{} `type:"structure"` + // Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED + // event. Can contain 0-20 key-value pairs. + // // Arguments is a required field Arguments map[string]*string `type:"map" required:"true"` + // The ID of the SIP media application handling the call. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` + // The ID of the call transaction. + // // TransactionId is a required field TransactionId *string `location:"uri" locationName:"transactionId" type:"string" required:"true"` } @@ -19446,6 +21191,7 @@ func (s *UpdateSipMediaApplicationCallInput) SetTransactionId(v string) *UpdateS type UpdateSipMediaApplicationCallOutput struct { _ struct{} `type:"structure"` + // A Call instance for a SIP media application. SipMediaApplicationCall *SipMediaApplicationCall `type:"structure"` } @@ -19476,10 +21222,14 @@ func (s *UpdateSipMediaApplicationCallOutput) SetSipMediaApplicationCall(v *SipM type UpdateSipMediaApplicationInput struct { _ struct{} `type:"structure"` + // The new set of endpoints for the specified SIP media application. Endpoints []*SipMediaApplicationEndpoint `min:"1" type:"list"` + // The new name for the specified SIP media application. Name *string `min:"1" type:"string"` + // The SIP media application ID. + // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` } @@ -19545,6 +21295,7 @@ func (s *UpdateSipMediaApplicationInput) SetSipMediaApplicationId(v string) *Upd type UpdateSipMediaApplicationOutput struct { _ struct{} `type:"structure"` + // The updated SIP media application’s details. SipMediaApplication *SipMediaApplication `type:"structure"` } @@ -19575,14 +21326,20 @@ func (s *UpdateSipMediaApplicationOutput) SetSipMediaApplication(v *SipMediaAppl type UpdateSipRuleInput struct { _ struct{} `type:"structure"` + // The new value that indicates whether the rule is disabled. Disabled *bool `type:"boolean"` + // The new name for the specified SIP rule. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // The SIP rule ID. + // // SipRuleId is a required field SipRuleId *string `location:"uri" locationName:"sipRuleId" type:"string" required:"true"` + // The new list of target applications. TargetApplications []*SipRuleTargetApplication `min:"1" type:"list"` } @@ -19666,6 +21423,7 @@ func (s *UpdateSipRuleInput) SetTargetApplications(v []*SipRuleTargetApplication type UpdateSipRuleOutput struct { _ struct{} `type:"structure"` + // The updated SIP rule details. SipRule *SipRule `type:"structure"` } @@ -19696,12 +21454,18 @@ func (s *UpdateSipRuleOutput) SetSipRule(v *SipRule) *UpdateSipRuleOutput { type UpdateVoiceConnectorGroupInput struct { _ struct{} `type:"structure"` + // The name of the Voice Connector group. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorGroupId is a required field VoiceConnectorGroupId *string `location:"uri" locationName:"voiceConnectorGroupId" type:"string" required:"true"` + // The VoiceConnectorItems to associate with the Voice Connector group. + // // VoiceConnectorItems is a required field VoiceConnectorItems []*VoiceConnectorItem `type:"list" required:"true"` } @@ -19780,6 +21544,7 @@ func (s *UpdateVoiceConnectorGroupInput) SetVoiceConnectorItems(v []*VoiceConnec type UpdateVoiceConnectorGroupOutput struct { _ struct{} `type:"structure"` + // The updated Voice Connector group. VoiceConnectorGroup *VoiceConnectorGroup `type:"structure"` } @@ -19810,12 +21575,18 @@ func (s *UpdateVoiceConnectorGroupOutput) SetVoiceConnectorGroup(v *VoiceConnect type UpdateVoiceConnectorInput struct { _ struct{} `type:"structure"` + // The name of the Voice Connector. + // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // When enabled, requires encryption for the Voice Connector. + // // RequireEncryption is a required field RequireEncryption *bool `type:"boolean" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `location:"uri" locationName:"voiceConnectorId" type:"string" required:"true"` } @@ -19884,6 +21655,7 @@ func (s *UpdateVoiceConnectorInput) SetVoiceConnectorId(v string) *UpdateVoiceCo type UpdateVoiceConnectorOutput struct { _ struct{} `type:"structure"` + // The updated Voice Connector details. VoiceConnector *VoiceConnector `type:"structure"` } @@ -19914,10 +21686,14 @@ func (s *UpdateVoiceConnectorOutput) SetVoiceConnector(v *VoiceConnector) *Updat type UpdateVoiceProfileDomainInput struct { _ struct{} `type:"structure"` + // The description of the voice profile domain. Description *string `type:"string"` + // The name of the voice profile domain. Name *string `min:"1" type:"string"` + // The domain ID. + // // VoiceProfileDomainId is a required field VoiceProfileDomainId *string `location:"uri" locationName:"VoiceProfileDomainId" min:"1" type:"string" required:"true"` } @@ -19980,6 +21756,7 @@ func (s *UpdateVoiceProfileDomainInput) SetVoiceProfileDomainId(v string) *Updat type UpdateVoiceProfileDomainOutput struct { _ struct{} `type:"structure"` + // The updated details of the voice profile domain. VoiceProfileDomain *VoiceProfileDomain `type:"structure"` } @@ -20010,9 +21787,13 @@ func (s *UpdateVoiceProfileDomainOutput) SetVoiceProfileDomain(v *VoiceProfileDo type UpdateVoiceProfileInput struct { _ struct{} `type:"structure"` + // The ID of the speaker search task. + // // SpeakerSearchTaskId is a required field SpeakerSearchTaskId *string `min:"1" type:"string" required:"true"` + // The profile ID. + // // VoiceProfileId is a required field VoiceProfileId *string `location:"uri" locationName:"VoiceProfileId" min:"1" type:"string" required:"true"` } @@ -20072,6 +21853,7 @@ func (s *UpdateVoiceProfileInput) SetVoiceProfileId(v string) *UpdateVoiceProfil type UpdateVoiceProfileOutput struct { _ struct{} `type:"structure"` + // The updated voice profile settings. VoiceProfile *VoiceProfile `type:"structure"` } @@ -20102,42 +21884,62 @@ func (s *UpdateVoiceProfileOutput) SetVoiceProfile(v *VoiceProfile) *UpdateVoice type ValidateE911AddressInput struct { _ struct{} `type:"structure"` + // The AWS account ID. + // // AwsAccountId is a required field AwsAccountId *string `type:"string" required:"true"` + // The address city, such as Portland. + // // City is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // City is a required field City *string `type:"string" required:"true" sensitive:"true"` + // The country in the address being validated. + // // Country is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // Country is a required field Country *string `type:"string" required:"true" sensitive:"true"` + // The dress postal code, such 04352. + // // PostalCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // PostalCode is a required field PostalCode *string `type:"string" required:"true" sensitive:"true"` + // The address state, such as ME. + // // State is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // State is a required field State *string `type:"string" required:"true" sensitive:"true"` + // The address street information, such as 8th Avenue. + // // StreetInfo is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // StreetInfo is a required field StreetInfo *string `type:"string" required:"true" sensitive:"true"` + // The address street number, such as 200 or 2121. + // // StreetNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidateE911AddressInput's // String and GoString methods. + // // StreetNumber is a required field StreetNumber *string `type:"string" required:"true" sensitive:"true"` } @@ -20236,12 +22038,18 @@ func (s *ValidateE911AddressInput) SetStreetNumber(v string) *ValidateE911Addres type ValidateE911AddressOutput struct { _ struct{} `type:"structure"` + // The validated address. Address *Address `type:"structure"` + // The ID that represents the address. AddressExternalId *string `type:"string"` + // The list of address suggestions.. CandidateAddressList []*CandidateAddress `type:"list"` + // Number indicating the result of address validation. 0 means the address was + // perfect as-is and successfully validated. 1 means the address was corrected. + // 2 means the address sent was not close enough and was not validated. ValidationResult *int64 `type:"integer"` } @@ -20287,23 +22095,33 @@ func (s *ValidateE911AddressOutput) SetValidationResult(v int64) *ValidateE911Ad return s } +// The Amazon Chime SDK Voice Connector configuration, including outbound host +// name and encryption settings. type VoiceConnector struct { _ struct{} `type:"structure"` + // The AWS Region in which the Voice Connector is created. Default: us-east-1. AwsRegion *string `type:"string" enum:"VoiceConnectorAwsRegion"` + // The Voice Connector's creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The Voice Connector's name. Name *string `min:"1" type:"string"` + // The outbound host name for the Voice Connector. OutboundHostName *string `type:"string"` + // Enables or disables encryption for the Voice Connector. RequireEncryption *bool `type:"boolean"` + // The Voice Connector's updated timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ARN of the Voice Connector. VoiceConnectorArn *string `type:"string"` + // The Voice Connector's ID. VoiceConnectorId *string `type:"string"` } @@ -20373,19 +22191,29 @@ func (s *VoiceConnector) SetVoiceConnectorId(v string) *VoiceConnector { return s } +// The Amazon Chime SDK Voice Connector group configuration, including associated +// Voice Connectors. You can include Voice Connectors from different AWS Regions +// in a group. This creates a fault tolerant mechanism for fallback in case +// of availability events. type VoiceConnectorGroup struct { _ struct{} `type:"structure"` + // The Voice Connector group's creation time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The name of a Voice Connector group. Name *string `min:"1" type:"string"` + // The Voice Connector group's creation time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ARN of the Voice Connector group. VoiceConnectorGroupArn *string `type:"string"` + // The ID of a Voice Connector group. VoiceConnectorGroupId *string `type:"string"` + // The Voice Connectors to which you route inbound calls. VoiceConnectorItems []*VoiceConnectorItem `type:"list"` } @@ -20443,12 +22271,22 @@ func (s *VoiceConnectorGroup) SetVoiceConnectorItems(v []*VoiceConnectorItem) *V return s } +// For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors +// to which you route inbound calls. Includes priority configuration settings. +// Limit: 3 VoiceConnectorItems per Voice Connector group. type VoiceConnectorItem struct { _ struct{} `type:"structure"` + // The priority setting of a Voice Connector item. Calls are routed to hosts + // in priority order, with 1 as the highest priority. When hosts have equal + // priority, the system distributes calls among them based on their relative + // weight. + // // Priority is a required field Priority *int64 `min:"1" type:"integer" required:"true"` + // The Voice Connector ID. + // // VoiceConnectorId is a required field VoiceConnectorId *string `type:"string" required:"true"` } @@ -20502,9 +22340,12 @@ func (s *VoiceConnectorItem) SetVoiceConnectorId(v string) *VoiceConnectorItem { return s } +// The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets +// designated for storing call detail records. type VoiceConnectorSettings struct { _ struct{} `type:"structure"` + // The S3 bucket that stores the Voice Connector's call detail records. CdrBucket *string `type:"string"` } @@ -20532,22 +22373,31 @@ func (s *VoiceConnectorSettings) SetCdrBucket(v string) *VoiceConnectorSettings return s } +// The combination of a voice print and caller ID. type VoiceProfile struct { _ struct{} `type:"structure"` + // The time at which the voice profile was created and enrolled. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The time at which a voice profile expires unless you re-enroll the caller + // via the UpdateVoiceProfile API. ExpirationTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The time at which the voice profile was last updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ARN of the voice profile. + // // VoiceProfileArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by VoiceProfile's // String and GoString methods. VoiceProfileArn *string `min:"1" type:"string" sensitive:"true"` + // The ID of the domain that contains the voice profile. VoiceProfileDomainId *string `min:"1" type:"string"` + // The ID of the voice profile. VoiceProfileId *string `min:"1" type:"string"` } @@ -20605,24 +22455,33 @@ func (s *VoiceProfile) SetVoiceProfileId(v string) *VoiceProfile { return s } +// A collection of voice profiles. type VoiceProfileDomain struct { _ struct{} `type:"structure"` + // The time at which the voice profile domain was created. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The description of the voice profile domain. Description *string `type:"string"` + // The name of the voice profile domain. Name *string `min:"1" type:"string"` + // A structure that contains the configuration settings for server-side encryption. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` + // The time at which the voice profile was last updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The voice profile domain's Amazon Resource Number (ARN). + // // VoiceProfileDomainArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by VoiceProfileDomain's // String and GoString methods. VoiceProfileDomainArn *string `min:"1" type:"string" sensitive:"true"` + // The ID of the voice profile domain. VoiceProfileDomainId *string `min:"1" type:"string"` } @@ -20686,22 +22545,30 @@ func (s *VoiceProfileDomain) SetVoiceProfileDomainId(v string) *VoiceProfileDoma return s } +// A high-level overview of a voice profile domain. type VoiceProfileDomainSummary struct { _ struct{} `type:"structure"` + // The time at which the voice profile domain summary was created. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // Describes the voice profile domain summary. Description *string `type:"string"` + // The name of the voice profile domain summary. Name *string `min:"1" type:"string"` + // The time at which the voice profile domain summary was last updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ARN of a voice profile in a voice profile domain summary. + // // VoiceProfileDomainArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by VoiceProfileDomainSummary's // String and GoString methods. VoiceProfileDomainArn *string `min:"1" type:"string" sensitive:"true"` + // The ID of the voice profile domain summary. VoiceProfileDomainId *string `min:"1" type:"string"` } @@ -20759,22 +22626,32 @@ func (s *VoiceProfileDomainSummary) SetVoiceProfileDomainId(v string) *VoiceProf return s } +// A high-level summary of a voice profile. type VoiceProfileSummary struct { _ struct{} `type:"structure"` + // The time at which a voice profile summary was created. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // Extends the life of the voice profile. You can use UpdateVoiceProfile to + // refresh an existing voice profile's voice print and extend the life of the + // summary. ExpirationTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The time at which a voice profile summary was last updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ARN of the voice profile in a voice profile summary. + // // VoiceProfileArn is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by VoiceProfileSummary's // String and GoString methods. VoiceProfileArn *string `min:"1" type:"string" sensitive:"true"` + // The ID of the voice profile domain in a voice profile summary. VoiceProfileDomainId *string `min:"1" type:"string"` + // The ID of the voice profile in a voice profile summary. VoiceProfileId *string `min:"1" type:"string"` } @@ -20832,21 +22709,31 @@ func (s *VoiceProfileSummary) SetVoiceProfileId(v string) *VoiceProfileSummary { return s } +// A representation of an asynchronous request to perform voice tone analysis +// on a Voice Connector call. type VoiceToneAnalysisTask struct { _ struct{} `type:"structure"` + // The call details of a voice tone analysis task. CallDetails *CallDetails `type:"structure"` + // The time at which a voice tone analysis task was created. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The time at which a voice tone analysis task started. StartedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The status of a voice tone analysis task. StatusMessage *string `type:"string"` + // The time at which a voice tone analysis task was updated. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + // The ID of the voice tone analysis task. VoiceToneAnalysisTaskId *string `min:"1" type:"string"` + // The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, + // SUCCEEDED, FAILED, or STOPPED. VoiceToneAnalysisTaskStatus *string `type:"string"` } diff --git a/service/chimesdkvoice/doc.go b/service/chimesdkvoice/doc.go index 0dcc062dceb..a2f38b1592d 100644 --- a/service/chimesdkvoice/doc.go +++ b/service/chimesdkvoice/doc.go @@ -3,6 +3,12 @@ // Package chimesdkvoice provides the client and types for making API // requests to Amazon Chime SDK Voice. // +// The Amazon Chime SDK telephony APIs in this section enable developers to +// create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, +// and Amazon Chime SDK SIP media applications. Developers can also order and +// manage phone numbers, create and manage Voice Connectors and SIP media applications, +// and run voice analytics. +// // See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03 for more information on this service. // // See chimesdkvoice package documentation for more information. diff --git a/service/chimesdkvoice/errors.go b/service/chimesdkvoice/errors.go index b4eb7613a40..1ae60f0b17d 100644 --- a/service/chimesdkvoice/errors.go +++ b/service/chimesdkvoice/errors.go @@ -10,50 +10,75 @@ const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". + // + // You don't have the permissions needed to run this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeBadRequestException for service response error code // "BadRequestException". + // + // The input parameters don't match the service's restrictions. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". + // + // Multiple instances of the same request were made simultaneously. ErrCodeConflictException = "ConflictException" // ErrCodeForbiddenException for service response error code // "ForbiddenException". + // + // The client is permanently forbidden from making the request. ErrCodeForbiddenException = "ForbiddenException" // ErrCodeGoneException for service response error code // "GoneException". + // + // Access to the target resource is no longer available at the origin server. + // This condition is likely to be permanent. ErrCodeGoneException = "GoneException" // ErrCodeNotFoundException for service response error code // "NotFoundException". + // + // The requested resource couldn't be found. ErrCodeNotFoundException = "NotFoundException" // ErrCodeResourceLimitExceededException for service response error code // "ResourceLimitExceededException". + // + // The request exceeds the resource limit. ErrCodeResourceLimitExceededException = "ResourceLimitExceededException" // ErrCodeServiceFailureException for service response error code // "ServiceFailureException". + // + // The service encountered an unexpected error. ErrCodeServiceFailureException = "ServiceFailureException" // ErrCodeServiceUnavailableException for service response error code // "ServiceUnavailableException". + // + // The service is currently unavailable. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeThrottledClientException for service response error code // "ThrottledClientException". + // + // The number of customer requests exceeds the request rate limit. ErrCodeThrottledClientException = "ThrottledClientException" // ErrCodeUnauthorizedClientException for service response error code // "UnauthorizedClientException". + // + // The client isn't authorized to request a resource. ErrCodeUnauthorizedClientException = "UnauthorizedClientException" // ErrCodeUnprocessableEntityException for service response error code // "UnprocessableEntityException". + // + // A well-formed request couldn't be followed due to semantic errors. ErrCodeUnprocessableEntityException = "UnprocessableEntityException" ) diff --git a/service/connect/api.go b/service/connect/api.go index b504a5de641..0d6ad425697 100644 --- a/service/connect/api.go +++ b/service/connect/api.go @@ -7531,7 +7531,7 @@ func (c *Connect) GetMetricDataV2Request(input *GetMetricDataV2Input) (req *requ // the previous version of this API. It has new metrics, offers filtering at // a metric level, and offers the ability to filter and group data by channels, // queues, routing profiles, agents, and agent hierarchy levels. It can retrieve -// historical data for last the 14 days, in 24-hour intervals. +// historical data for the last 14 days, in 24-hour intervals. // // For a description of the historical metrics that are supported by GetMetricDataV2 // and GetMetricData, see Historical metrics definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) @@ -42852,7 +42852,7 @@ type StartChatContactInput struct { Attributes map[string]*string `type:"map"` // The total duration of the newly started chat session. If not specified, the - // chat session duration defaults to 25 hour. The minumum configurable time + // chat session duration defaults to 25 hour. The minimum configurable time // is 60 minutes. The maximum configurable time is 10,080 minutes (7 days). ChatDurationInMinutes *int64 `min:"60" type:"integer"` @@ -42893,11 +42893,24 @@ type StartChatContactInput struct { // chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). PersistentChat *PersistentChat `type:"structure"` - // The supported chat message content types. Content types must always contain - // text/plain. You can then put any other supported type in the list. For example, - // all the following lists are valid because they contain text/plain: [text/plain, - // text/markdown, application/json], [text/markdown, text/plain], [text/plain, - // application/json]. + // The unique identifier for an Amazon Connect contact. This identifier is related + // to the chat starting. + // + // You cannot provide data for both RelatedContactId and PersistentChat. + RelatedContactId *string `min:"1" type:"string"` + + // The supported chat message content types. Supported types are text/plain, + // text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, + // and application/vnd.amazonaws.connect.message.interactive.response. + // + // Content types must always contain text/plain. You can then put any other + // supported type in the list. For example, all the following lists are valid + // because they contain text/plain: [text/plain, text/markdown, application/json], + // [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]. + // + // The type application/vnd.amazonaws.connect.message.interactive is required + // to use the Show view (https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html) + // flow block. SupportedMessagingContentTypes []*string `type:"list"` } @@ -42937,6 +42950,9 @@ func (s *StartChatContactInput) Validate() error { if s.ParticipantDetails == nil { invalidParams.Add(request.NewErrParamRequired("ParticipantDetails")) } + if s.RelatedContactId != nil && len(*s.RelatedContactId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RelatedContactId", 1)) + } if s.InitialMessage != nil { if err := s.InitialMessage.Validate(); err != nil { invalidParams.AddNested("InitialMessage", err.(request.ErrInvalidParams)) @@ -43007,6 +43023,12 @@ func (s *StartChatContactInput) SetPersistentChat(v *PersistentChat) *StartChatC return s } +// SetRelatedContactId sets the RelatedContactId field's value. +func (s *StartChatContactInput) SetRelatedContactId(v string) *StartChatContactInput { + s.RelatedContactId = &v + return s +} + // SetSupportedMessagingContentTypes sets the SupportedMessagingContentTypes field's value. func (s *StartChatContactInput) SetSupportedMessagingContentTypes(v []*string) *StartChatContactInput { s.SupportedMessagingContentTypes = v diff --git a/service/connectparticipant/api.go b/service/connectparticipant/api.go index a7d29d8bd4c..3fb43d47134 100644 --- a/service/connectparticipant/api.go +++ b/service/connectparticipant/api.go @@ -1206,7 +1206,8 @@ type CreateParticipantConnectionInput struct { _ struct{} `type:"structure"` // Amazon Connect Participant is used to mark the participant as connected for - // message streaming. + // customer participant in message streaming, as well as for agent or manager + // participant in non-streaming chats. ConnectParticipant *bool `type:"boolean"` // This is a header parameter. @@ -2135,11 +2136,14 @@ type SendMessageInput struct { // * For application/json, the Length Constraints are Minimum of 1, Maximum // of 12000. // + // * For application/vnd.amazonaws.connect.message.interactive.response, + // the Length Constraints are Minimum of 1, Maximum of 12288. + // // Content is a required field Content *string `min:"1" type:"string" required:"true"` - // The type of the content. Supported types are text/plain, text/markdown, and - // application/json. + // The type of the content. Supported types are text/plain, text/markdown, application/json, + // and application/vnd.amazonaws.connect.message.interactive.response. // // ContentType is a required field ContentType *string `min:"1" type:"string" required:"true"` diff --git a/service/connectparticipant/doc.go b/service/connectparticipant/doc.go index f1b38df39e1..0b7676c1c18 100644 --- a/service/connectparticipant/doc.go +++ b/service/connectparticipant/doc.go @@ -3,10 +3,17 @@ // Package connectparticipant provides the client and types for making API // requests to Amazon Connect Participant Service. // -// Amazon Connect is a cloud-based contact center solution that makes it easy -// to set up and manage a customer contact center. Amazon Connect enables customer -// contacts through voice or chat. Use the Amazon Connect Participant Service -// to manage chat participants, such as agents and customers. +// Amazon Connect is an easy-to-use omnichannel cloud contact center service +// that enables companies of any size to deliver superior customer service at +// a lower cost. Amazon Connect communications capabilities make it easy for +// companies to deliver personalized interactions across communication channels, +// including chat. +// +// Use the Amazon Connect Participant Service to manage participants (for example, +// agents, customers, and managers listening in), and to send messages and events +// within a chat contact. The APIs in the service enable the following: sending +// chat messages, attachment sharing, managing a participant's connection state +// and message events, and retrieving chat transcripts. // // See https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07 for more information on this service. // diff --git a/service/iotwireless/api.go b/service/iotwireless/api.go index 52efd13a639..f5ec6391417 100644 --- a/service/iotwireless/api.go +++ b/service/iotwireless/api.go @@ -2453,6 +2453,101 @@ func (c *IoTWireless) DeleteWirelessDeviceWithContext(ctx aws.Context, input *De return out, req.Send() } +const opDeleteWirelessDeviceImportTask = "DeleteWirelessDeviceImportTask" + +// DeleteWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWirelessDeviceImportTask operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteWirelessDeviceImportTask for more information on using the DeleteWirelessDeviceImportTask +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteWirelessDeviceImportTaskRequest method. +// req, resp := client.DeleteWirelessDeviceImportTaskRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeleteWirelessDeviceImportTask +func (c *IoTWireless) DeleteWirelessDeviceImportTaskRequest(input *DeleteWirelessDeviceImportTaskInput) (req *request.Request, output *DeleteWirelessDeviceImportTaskOutput) { + op := &request.Operation{ + Name: opDeleteWirelessDeviceImportTask, + HTTPMethod: "DELETE", + HTTPPath: "/wireless_device_import_task/{Id}", + } + + if input == nil { + input = &DeleteWirelessDeviceImportTaskInput{} + } + + output = &DeleteWirelessDeviceImportTaskOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteWirelessDeviceImportTask API operation for AWS IoT Wireless. +// +// Delete an import task. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation DeleteWirelessDeviceImportTask for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - AccessDeniedException +// User does not have permission to perform this action. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeleteWirelessDeviceImportTask +func (c *IoTWireless) DeleteWirelessDeviceImportTask(input *DeleteWirelessDeviceImportTaskInput) (*DeleteWirelessDeviceImportTaskOutput, error) { + req, out := c.DeleteWirelessDeviceImportTaskRequest(input) + return out, req.Send() +} + +// DeleteWirelessDeviceImportTaskWithContext is the same as DeleteWirelessDeviceImportTask with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteWirelessDeviceImportTask for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) DeleteWirelessDeviceImportTaskWithContext(ctx aws.Context, input *DeleteWirelessDeviceImportTaskInput, opts ...request.Option) (*DeleteWirelessDeviceImportTaskOutput, error) { + req, out := c.DeleteWirelessDeviceImportTaskRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteWirelessGateway = "DeleteWirelessGateway" // DeleteWirelessGatewayRequest generates a "aws/request.Request" representing the @@ -2730,6 +2825,95 @@ func (c *IoTWireless) DeleteWirelessGatewayTaskDefinitionWithContext(ctx aws.Con return out, req.Send() } +const opDeregisterWirelessDevice = "DeregisterWirelessDevice" + +// DeregisterWirelessDeviceRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterWirelessDevice operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeregisterWirelessDevice for more information on using the DeregisterWirelessDevice +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeregisterWirelessDeviceRequest method. +// req, resp := client.DeregisterWirelessDeviceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeregisterWirelessDevice +func (c *IoTWireless) DeregisterWirelessDeviceRequest(input *DeregisterWirelessDeviceInput) (req *request.Request, output *DeregisterWirelessDeviceOutput) { + op := &request.Operation{ + Name: opDeregisterWirelessDevice, + HTTPMethod: "PATCH", + HTTPPath: "/wireless-devices/{Identifier}/deregister", + } + + if input == nil { + input = &DeregisterWirelessDeviceInput{} + } + + output = &DeregisterWirelessDeviceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeregisterWirelessDevice API operation for AWS IoT Wireless. +// +// Deregister a wireless device from AWS IoT Wireless. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation DeregisterWirelessDevice for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeregisterWirelessDevice +func (c *IoTWireless) DeregisterWirelessDevice(input *DeregisterWirelessDeviceInput) (*DeregisterWirelessDeviceOutput, error) { + req, out := c.DeregisterWirelessDeviceRequest(input) + return out, req.Send() +} + +// DeregisterWirelessDeviceWithContext is the same as DeregisterWirelessDevice with the addition of +// the ability to pass a context and additional request options. +// +// See DeregisterWirelessDevice for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) DeregisterWirelessDeviceWithContext(ctx aws.Context, input *DeregisterWirelessDeviceInput, opts ...request.Option) (*DeregisterWirelessDeviceOutput, error) { + req, out := c.DeregisterWirelessDeviceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDisassociateAwsAccountFromPartnerAccount = "DisassociateAwsAccountFromPartnerAccount" // DisassociateAwsAccountFromPartnerAccountRequest generates a "aws/request.Request" representing the @@ -5043,6 +5227,101 @@ func (c *IoTWireless) GetWirelessDeviceWithContext(ctx aws.Context, input *GetWi return out, req.Send() } +const opGetWirelessDeviceImportTask = "GetWirelessDeviceImportTask" + +// GetWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the GetWirelessDeviceImportTask operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetWirelessDeviceImportTask for more information on using the GetWirelessDeviceImportTask +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetWirelessDeviceImportTaskRequest method. +// req, resp := client.GetWirelessDeviceImportTaskRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/GetWirelessDeviceImportTask +func (c *IoTWireless) GetWirelessDeviceImportTaskRequest(input *GetWirelessDeviceImportTaskInput) (req *request.Request, output *GetWirelessDeviceImportTaskOutput) { + op := &request.Operation{ + Name: opGetWirelessDeviceImportTask, + HTTPMethod: "GET", + HTTPPath: "/wireless_device_import_task/{Id}", + } + + if input == nil { + input = &GetWirelessDeviceImportTaskInput{} + } + + output = &GetWirelessDeviceImportTaskOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetWirelessDeviceImportTask API operation for AWS IoT Wireless. +// +// Get information about an import task and count of device onboarding summary +// information for the import task. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation GetWirelessDeviceImportTask for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - AccessDeniedException +// User does not have permission to perform this action. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/GetWirelessDeviceImportTask +func (c *IoTWireless) GetWirelessDeviceImportTask(input *GetWirelessDeviceImportTaskInput) (*GetWirelessDeviceImportTaskOutput, error) { + req, out := c.GetWirelessDeviceImportTaskRequest(input) + return out, req.Send() +} + +// GetWirelessDeviceImportTaskWithContext is the same as GetWirelessDeviceImportTask with the addition of +// the ability to pass a context and additional request options. +// +// See GetWirelessDeviceImportTask for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) GetWirelessDeviceImportTaskWithContext(ctx aws.Context, input *GetWirelessDeviceImportTaskInput, opts ...request.Option) (*GetWirelessDeviceImportTaskOutput, error) { + req, out := c.GetWirelessDeviceImportTaskRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetWirelessDeviceStatistics = "GetWirelessDeviceStatistics" // GetWirelessDeviceStatisticsRequest generates a "aws/request.Request" representing the @@ -5971,57 +6250,57 @@ func (c *IoTWireless) ListDeviceProfilesPagesWithContext(ctx aws.Context, input return p.Err() } -const opListEventConfigurations = "ListEventConfigurations" +const opListDevicesForWirelessDeviceImportTask = "ListDevicesForWirelessDeviceImportTask" -// ListEventConfigurationsRequest generates a "aws/request.Request" representing the -// client's request for the ListEventConfigurations operation. The "output" return +// ListDevicesForWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the ListDevicesForWirelessDeviceImportTask operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListEventConfigurations for more information on using the ListEventConfigurations +// See ListDevicesForWirelessDeviceImportTask for more information on using the ListDevicesForWirelessDeviceImportTask // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListEventConfigurationsRequest method. -// req, resp := client.ListEventConfigurationsRequest(params) +// // Example sending a request using the ListDevicesForWirelessDeviceImportTaskRequest method. +// req, resp := client.ListDevicesForWirelessDeviceImportTaskRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations -func (c *IoTWireless) ListEventConfigurationsRequest(input *ListEventConfigurationsInput) (req *request.Request, output *ListEventConfigurationsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListDevicesForWirelessDeviceImportTask +func (c *IoTWireless) ListDevicesForWirelessDeviceImportTaskRequest(input *ListDevicesForWirelessDeviceImportTaskInput) (req *request.Request, output *ListDevicesForWirelessDeviceImportTaskOutput) { op := &request.Operation{ - Name: opListEventConfigurations, + Name: opListDevicesForWirelessDeviceImportTask, HTTPMethod: "GET", - HTTPPath: "/event-configurations", + HTTPPath: "/wireless_device_import_task", } if input == nil { - input = &ListEventConfigurationsInput{} + input = &ListDevicesForWirelessDeviceImportTaskInput{} } - output = &ListEventConfigurationsOutput{} + output = &ListDevicesForWirelessDeviceImportTaskOutput{} req = c.newRequest(op, input, output) return } -// ListEventConfigurations API operation for AWS IoT Wireless. +// ListDevicesForWirelessDeviceImportTask API operation for AWS IoT Wireless. // -// List event configurations where at least one event topic has been enabled. +// List the Sidewalk devices in an import task and their onboarding status. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation ListEventConfigurations for usage and error information. +// API operation ListDevicesForWirelessDeviceImportTask for usage and error information. // // Returned Error Types: // @@ -6031,52 +6310,146 @@ func (c *IoTWireless) ListEventConfigurationsRequest(input *ListEventConfigurati // - AccessDeniedException // User does not have permission to perform this action. // -// - ThrottlingException -// The request was denied because it exceeded the allowed API request rate. +// - ResourceNotFoundException +// Resource does not exist. // // - InternalServerException // An unexpected error occurred while processing a request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations -func (c *IoTWireless) ListEventConfigurations(input *ListEventConfigurationsInput) (*ListEventConfigurationsOutput, error) { - req, out := c.ListEventConfigurationsRequest(input) +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListDevicesForWirelessDeviceImportTask +func (c *IoTWireless) ListDevicesForWirelessDeviceImportTask(input *ListDevicesForWirelessDeviceImportTaskInput) (*ListDevicesForWirelessDeviceImportTaskOutput, error) { + req, out := c.ListDevicesForWirelessDeviceImportTaskRequest(input) return out, req.Send() } -// ListEventConfigurationsWithContext is the same as ListEventConfigurations with the addition of +// ListDevicesForWirelessDeviceImportTaskWithContext is the same as ListDevicesForWirelessDeviceImportTask with the addition of // the ability to pass a context and additional request options. // -// See ListEventConfigurations for details on how to use this API operation. +// See ListDevicesForWirelessDeviceImportTask for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) ListEventConfigurationsWithContext(ctx aws.Context, input *ListEventConfigurationsInput, opts ...request.Option) (*ListEventConfigurationsOutput, error) { - req, out := c.ListEventConfigurationsRequest(input) +func (c *IoTWireless) ListDevicesForWirelessDeviceImportTaskWithContext(ctx aws.Context, input *ListDevicesForWirelessDeviceImportTaskInput, opts ...request.Option) (*ListDevicesForWirelessDeviceImportTaskOutput, error) { + req, out := c.ListDevicesForWirelessDeviceImportTaskRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListFuotaTasks = "ListFuotaTasks" +const opListEventConfigurations = "ListEventConfigurations" -// ListFuotaTasksRequest generates a "aws/request.Request" representing the -// client's request for the ListFuotaTasks operation. The "output" return +// ListEventConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListEventConfigurations operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListFuotaTasks for more information on using the ListFuotaTasks +// See ListEventConfigurations for more information on using the ListEventConfigurations // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListFuotaTasksRequest method. -// req, resp := client.ListFuotaTasksRequest(params) +// // Example sending a request using the ListEventConfigurationsRequest method. +// req, resp := client.ListEventConfigurationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations +func (c *IoTWireless) ListEventConfigurationsRequest(input *ListEventConfigurationsInput) (req *request.Request, output *ListEventConfigurationsOutput) { + op := &request.Operation{ + Name: opListEventConfigurations, + HTTPMethod: "GET", + HTTPPath: "/event-configurations", + } + + if input == nil { + input = &ListEventConfigurationsInput{} + } + + output = &ListEventConfigurationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListEventConfigurations API operation for AWS IoT Wireless. +// +// List event configurations where at least one event topic has been enabled. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation ListEventConfigurations for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - AccessDeniedException +// User does not have permission to perform this action. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations +func (c *IoTWireless) ListEventConfigurations(input *ListEventConfigurationsInput) (*ListEventConfigurationsOutput, error) { + req, out := c.ListEventConfigurationsRequest(input) + return out, req.Send() +} + +// ListEventConfigurationsWithContext is the same as ListEventConfigurations with the addition of +// the ability to pass a context and additional request options. +// +// See ListEventConfigurations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) ListEventConfigurationsWithContext(ctx aws.Context, input *ListEventConfigurationsInput, opts ...request.Option) (*ListEventConfigurationsOutput, error) { + req, out := c.ListEventConfigurationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListFuotaTasks = "ListFuotaTasks" + +// ListFuotaTasksRequest generates a "aws/request.Request" representing the +// client's request for the ListFuotaTasks operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListFuotaTasks for more information on using the ListFuotaTasks +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListFuotaTasksRequest method. +// req, resp := client.ListFuotaTasksRequest(params) // // err := req.Send() // if err == nil { // resp is now filled @@ -7276,6 +7649,100 @@ func (c *IoTWireless) ListTagsForResourceWithContext(ctx aws.Context, input *Lis return out, req.Send() } +const opListWirelessDeviceImportTasks = "ListWirelessDeviceImportTasks" + +// ListWirelessDeviceImportTasksRequest generates a "aws/request.Request" representing the +// client's request for the ListWirelessDeviceImportTasks operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListWirelessDeviceImportTasks for more information on using the ListWirelessDeviceImportTasks +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListWirelessDeviceImportTasksRequest method. +// req, resp := client.ListWirelessDeviceImportTasksRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListWirelessDeviceImportTasks +func (c *IoTWireless) ListWirelessDeviceImportTasksRequest(input *ListWirelessDeviceImportTasksInput) (req *request.Request, output *ListWirelessDeviceImportTasksOutput) { + op := &request.Operation{ + Name: opListWirelessDeviceImportTasks, + HTTPMethod: "GET", + HTTPPath: "/wireless_device_import_tasks", + } + + if input == nil { + input = &ListWirelessDeviceImportTasksInput{} + } + + output = &ListWirelessDeviceImportTasksOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWirelessDeviceImportTasks API operation for AWS IoT Wireless. +// +// List wireless devices that have been added to an import task. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation ListWirelessDeviceImportTasks for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - AccessDeniedException +// User does not have permission to perform this action. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListWirelessDeviceImportTasks +func (c *IoTWireless) ListWirelessDeviceImportTasks(input *ListWirelessDeviceImportTasksInput) (*ListWirelessDeviceImportTasksOutput, error) { + req, out := c.ListWirelessDeviceImportTasksRequest(input) + return out, req.Send() +} + +// ListWirelessDeviceImportTasksWithContext is the same as ListWirelessDeviceImportTasks with the addition of +// the ability to pass a context and additional request options. +// +// See ListWirelessDeviceImportTasks for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) ListWirelessDeviceImportTasksWithContext(ctx aws.Context, input *ListWirelessDeviceImportTasksInput, opts ...request.Option) (*ListWirelessDeviceImportTasksOutput, error) { + req, out := c.ListWirelessDeviceImportTasksRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListWirelessDevices = "ListWirelessDevices" // ListWirelessDevicesRequest generates a "aws/request.Request" representing the @@ -8597,234 +9064,423 @@ func (c *IoTWireless) StartMulticastGroupSessionWithContext(ctx aws.Context, inp return out, req.Send() } -const opTagResource = "TagResource" +const opStartSingleWirelessDeviceImportTask = "StartSingleWirelessDeviceImportTask" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// StartSingleWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the StartSingleWirelessDeviceImportTask operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TagResource for more information on using the TagResource +// See StartSingleWirelessDeviceImportTask for more information on using the StartSingleWirelessDeviceImportTask // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the StartSingleWirelessDeviceImportTaskRequest method. +// req, resp := client.StartSingleWirelessDeviceImportTaskRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TagResource -func (c *IoTWireless) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/StartSingleWirelessDeviceImportTask +func (c *IoTWireless) StartSingleWirelessDeviceImportTaskRequest(input *StartSingleWirelessDeviceImportTaskInput) (req *request.Request, output *StartSingleWirelessDeviceImportTaskOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opStartSingleWirelessDeviceImportTask, HTTPMethod: "POST", - HTTPPath: "/tags", + HTTPPath: "/wireless_single_device_import_task", } if input == nil { - input = &TagResourceInput{} + input = &StartSingleWirelessDeviceImportTaskInput{} } - output = &TagResourceOutput{} + output = &StartSingleWirelessDeviceImportTaskOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for AWS IoT Wireless. +// StartSingleWirelessDeviceImportTask API operation for AWS IoT Wireless. // -// Adds a tag to a resource. +// Start import task for a single wireless device. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation TagResource for usage and error information. +// API operation StartSingleWirelessDeviceImportTask for usage and error information. // // Returned Error Types: // // - ValidationException // The input did not meet the specified constraints. // +// - AccessDeniedException +// User does not have permission to perform this action. +// // - ResourceNotFoundException // Resource does not exist. // -// - ConflictException -// Adding, updating, or deleting the resource can cause an inconsistent state. -// // - InternalServerException // An unexpected error occurred while processing a request. // +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// // - ThrottlingException // The request was denied because it exceeded the allowed API request rate. // -// - TooManyTagsException -// The request was denied because the resource can't have any more tags. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TagResource -func (c *IoTWireless) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/StartSingleWirelessDeviceImportTask +func (c *IoTWireless) StartSingleWirelessDeviceImportTask(input *StartSingleWirelessDeviceImportTaskInput) (*StartSingleWirelessDeviceImportTaskOutput, error) { + req, out := c.StartSingleWirelessDeviceImportTaskRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// StartSingleWirelessDeviceImportTaskWithContext is the same as StartSingleWirelessDeviceImportTask with the addition of // the ability to pass a context and additional request options. // -// See TagResource for details on how to use this API operation. +// See StartSingleWirelessDeviceImportTask for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *IoTWireless) StartSingleWirelessDeviceImportTaskWithContext(ctx aws.Context, input *StartSingleWirelessDeviceImportTaskInput, opts ...request.Option) (*StartSingleWirelessDeviceImportTaskOutput, error) { + req, out := c.StartSingleWirelessDeviceImportTaskRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTestWirelessDevice = "TestWirelessDevice" +const opStartWirelessDeviceImportTask = "StartWirelessDeviceImportTask" -// TestWirelessDeviceRequest generates a "aws/request.Request" representing the -// client's request for the TestWirelessDevice operation. The "output" return +// StartWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the StartWirelessDeviceImportTask operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TestWirelessDevice for more information on using the TestWirelessDevice +// See StartWirelessDeviceImportTask for more information on using the StartWirelessDeviceImportTask // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the TestWirelessDeviceRequest method. -// req, resp := client.TestWirelessDeviceRequest(params) +// // Example sending a request using the StartWirelessDeviceImportTaskRequest method. +// req, resp := client.StartWirelessDeviceImportTaskRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TestWirelessDevice -func (c *IoTWireless) TestWirelessDeviceRequest(input *TestWirelessDeviceInput) (req *request.Request, output *TestWirelessDeviceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/StartWirelessDeviceImportTask +func (c *IoTWireless) StartWirelessDeviceImportTaskRequest(input *StartWirelessDeviceImportTaskInput) (req *request.Request, output *StartWirelessDeviceImportTaskOutput) { op := &request.Operation{ - Name: opTestWirelessDevice, + Name: opStartWirelessDeviceImportTask, HTTPMethod: "POST", - HTTPPath: "/wireless-devices/{Id}/test", + HTTPPath: "/wireless_device_import_task", } if input == nil { - input = &TestWirelessDeviceInput{} + input = &StartWirelessDeviceImportTaskInput{} } - output = &TestWirelessDeviceOutput{} + output = &StartWirelessDeviceImportTaskOutput{} req = c.newRequest(op, input, output) return } -// TestWirelessDevice API operation for AWS IoT Wireless. +// StartWirelessDeviceImportTask API operation for AWS IoT Wireless. // -// Simulates a provisioned device by sending an uplink data payload of Hello. +// Start import task for provisioning Sidewalk devices in bulk using an S3 CSV +// file. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation TestWirelessDevice for usage and error information. +// API operation StartWirelessDeviceImportTask for usage and error information. // // Returned Error Types: // // - ValidationException // The input did not meet the specified constraints. // +// - AccessDeniedException +// User does not have permission to perform this action. +// // - ResourceNotFoundException // Resource does not exist. // -// - ThrottlingException -// The request was denied because it exceeded the allowed API request rate. -// // - InternalServerException // An unexpected error occurred while processing a request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TestWirelessDevice -func (c *IoTWireless) TestWirelessDevice(input *TestWirelessDeviceInput) (*TestWirelessDeviceOutput, error) { - req, out := c.TestWirelessDeviceRequest(input) +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/StartWirelessDeviceImportTask +func (c *IoTWireless) StartWirelessDeviceImportTask(input *StartWirelessDeviceImportTaskInput) (*StartWirelessDeviceImportTaskOutput, error) { + req, out := c.StartWirelessDeviceImportTaskRequest(input) return out, req.Send() } -// TestWirelessDeviceWithContext is the same as TestWirelessDevice with the addition of +// StartWirelessDeviceImportTaskWithContext is the same as StartWirelessDeviceImportTask with the addition of // the ability to pass a context and additional request options. // -// See TestWirelessDevice for details on how to use this API operation. +// See StartWirelessDeviceImportTask for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) TestWirelessDeviceWithContext(ctx aws.Context, input *TestWirelessDeviceInput, opts ...request.Option) (*TestWirelessDeviceOutput, error) { - req, out := c.TestWirelessDeviceRequest(input) +func (c *IoTWireless) StartWirelessDeviceImportTaskWithContext(ctx aws.Context, input *StartWirelessDeviceImportTaskInput, opts ...request.Option) (*StartWirelessDeviceImportTaskOutput, error) { + req, out := c.StartWirelessDeviceImportTaskRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +const opTagResource = "TagResource" -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UntagResource for more information on using the UntagResource +// See TagResource for more information on using the TagResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UntagResource -func (c *IoTWireless) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TagResource +func (c *IoTWireless) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { op := &request.Operation{ - Name: opUntagResource, - HTTPMethod: "DELETE", + Name: opTagResource, + HTTPMethod: "POST", HTTPPath: "/tags", } if input == nil { - input = &UntagResourceInput{} + input = &TagResourceInput{} } - output = &UntagResourceOutput{} + output = &TagResourceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for AWS IoT Wireless. +// TagResource API operation for AWS IoT Wireless. // -// Removes one or more tags from a resource. +// Adds a tag to a resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// - TooManyTagsException +// The request was denied because the resource can't have any more tags. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TagResource +func (c *IoTWireless) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTestWirelessDevice = "TestWirelessDevice" + +// TestWirelessDeviceRequest generates a "aws/request.Request" representing the +// client's request for the TestWirelessDevice operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TestWirelessDevice for more information on using the TestWirelessDevice +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the TestWirelessDeviceRequest method. +// req, resp := client.TestWirelessDeviceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TestWirelessDevice +func (c *IoTWireless) TestWirelessDeviceRequest(input *TestWirelessDeviceInput) (req *request.Request, output *TestWirelessDeviceOutput) { + op := &request.Operation{ + Name: opTestWirelessDevice, + HTTPMethod: "POST", + HTTPPath: "/wireless-devices/{Id}/test", + } + + if input == nil { + input = &TestWirelessDeviceInput{} + } + + output = &TestWirelessDeviceOutput{} + req = c.newRequest(op, input, output) + return +} + +// TestWirelessDevice API operation for AWS IoT Wireless. +// +// Simulates a provisioned device by sending an uplink data payload of Hello. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation TestWirelessDevice for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/TestWirelessDevice +func (c *IoTWireless) TestWirelessDevice(input *TestWirelessDeviceInput) (*TestWirelessDeviceOutput, error) { + req, out := c.TestWirelessDeviceRequest(input) + return out, req.Send() +} + +// TestWirelessDeviceWithContext is the same as TestWirelessDevice with the addition of +// the ability to pass a context and additional request options. +// +// See TestWirelessDevice for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) TestWirelessDeviceWithContext(ctx aws.Context, input *TestWirelessDeviceInput, opts ...request.Option) (*TestWirelessDeviceOutput, error) { + req, out := c.TestWirelessDeviceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UntagResource +func (c *IoTWireless) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS IoT Wireless. +// +// Removes one or more tags from a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9907,135 +10563,230 @@ func (c *IoTWireless) UpdateWirelessDeviceWithContext(ctx aws.Context, input *Up return out, req.Send() } -const opUpdateWirelessGateway = "UpdateWirelessGateway" +const opUpdateWirelessDeviceImportTask = "UpdateWirelessDeviceImportTask" -// UpdateWirelessGatewayRequest generates a "aws/request.Request" representing the -// client's request for the UpdateWirelessGateway operation. The "output" return +// UpdateWirelessDeviceImportTaskRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWirelessDeviceImportTask operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateWirelessGateway for more information on using the UpdateWirelessGateway +// See UpdateWirelessDeviceImportTask for more information on using the UpdateWirelessDeviceImportTask // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UpdateWirelessGatewayRequest method. -// req, resp := client.UpdateWirelessGatewayRequest(params) +// // Example sending a request using the UpdateWirelessDeviceImportTaskRequest method. +// req, resp := client.UpdateWirelessDeviceImportTaskRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessGateway -func (c *IoTWireless) UpdateWirelessGatewayRequest(input *UpdateWirelessGatewayInput) (req *request.Request, output *UpdateWirelessGatewayOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessDeviceImportTask +func (c *IoTWireless) UpdateWirelessDeviceImportTaskRequest(input *UpdateWirelessDeviceImportTaskInput) (req *request.Request, output *UpdateWirelessDeviceImportTaskOutput) { op := &request.Operation{ - Name: opUpdateWirelessGateway, + Name: opUpdateWirelessDeviceImportTask, HTTPMethod: "PATCH", - HTTPPath: "/wireless-gateways/{Id}", + HTTPPath: "/wireless_device_import_task/{Id}", } if input == nil { - input = &UpdateWirelessGatewayInput{} + input = &UpdateWirelessDeviceImportTaskInput{} } - output = &UpdateWirelessGatewayOutput{} + output = &UpdateWirelessDeviceImportTaskOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateWirelessGateway API operation for AWS IoT Wireless. +// UpdateWirelessDeviceImportTask API operation for AWS IoT Wireless. // -// Updates properties of a wireless gateway. +// Update an import task to add more devices to the task. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation UpdateWirelessGateway for usage and error information. +// API operation UpdateWirelessDeviceImportTask for usage and error information. // // Returned Error Types: // // - ValidationException // The input did not meet the specified constraints. // -// - ResourceNotFoundException -// Resource does not exist. -// // - AccessDeniedException // User does not have permission to perform this action. // +// - ResourceNotFoundException +// Resource does not exist. +// // - InternalServerException // An unexpected error occurred while processing a request. // +// - ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// // - ThrottlingException // The request was denied because it exceeded the allowed API request rate. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessGateway -func (c *IoTWireless) UpdateWirelessGateway(input *UpdateWirelessGatewayInput) (*UpdateWirelessGatewayOutput, error) { - req, out := c.UpdateWirelessGatewayRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessDeviceImportTask +func (c *IoTWireless) UpdateWirelessDeviceImportTask(input *UpdateWirelessDeviceImportTaskInput) (*UpdateWirelessDeviceImportTaskOutput, error) { + req, out := c.UpdateWirelessDeviceImportTaskRequest(input) return out, req.Send() } -// UpdateWirelessGatewayWithContext is the same as UpdateWirelessGateway with the addition of +// UpdateWirelessDeviceImportTaskWithContext is the same as UpdateWirelessDeviceImportTask with the addition of // the ability to pass a context and additional request options. // -// See UpdateWirelessGateway for details on how to use this API operation. +// See UpdateWirelessDeviceImportTask for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) UpdateWirelessGatewayWithContext(ctx aws.Context, input *UpdateWirelessGatewayInput, opts ...request.Option) (*UpdateWirelessGatewayOutput, error) { - req, out := c.UpdateWirelessGatewayRequest(input) +func (c *IoTWireless) UpdateWirelessDeviceImportTaskWithContext(ctx aws.Context, input *UpdateWirelessDeviceImportTaskInput, opts ...request.Option) (*UpdateWirelessDeviceImportTaskOutput, error) { + req, out := c.UpdateWirelessDeviceImportTaskRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ABP device object for LoRaWAN specification v1.0.x -type AbpV10X struct { - _ struct{} `type:"structure"` - - // The DevAddr value. - DevAddr *string `type:"string"` - - // The FCnt init value. - FCntStart *int64 `type:"integer"` - - // Session keys for ABP v1.0.x - SessionKeys *SessionKeysAbpV10X `type:"structure"` -} +const opUpdateWirelessGateway = "UpdateWirelessGateway" -// String returns the string representation. +// UpdateWirelessGatewayRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWirelessGateway operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AbpV10X) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AbpV10X) GoString() string { - return s.String() -} - -// SetDevAddr sets the DevAddr field's value. -func (s *AbpV10X) SetDevAddr(v string) *AbpV10X { - s.DevAddr = &v - return s -} +// See UpdateWirelessGateway for more information on using the UpdateWirelessGateway +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateWirelessGatewayRequest method. +// req, resp := client.UpdateWirelessGatewayRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessGateway +func (c *IoTWireless) UpdateWirelessGatewayRequest(input *UpdateWirelessGatewayInput) (req *request.Request, output *UpdateWirelessGatewayOutput) { + op := &request.Operation{ + Name: opUpdateWirelessGateway, + HTTPMethod: "PATCH", + HTTPPath: "/wireless-gateways/{Id}", + } + + if input == nil { + input = &UpdateWirelessGatewayInput{} + } + + output = &UpdateWirelessGatewayOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateWirelessGateway API operation for AWS IoT Wireless. +// +// Updates properties of a wireless gateway. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation UpdateWirelessGateway for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input did not meet the specified constraints. +// +// - ResourceNotFoundException +// Resource does not exist. +// +// - AccessDeniedException +// User does not have permission to perform this action. +// +// - InternalServerException +// An unexpected error occurred while processing a request. +// +// - ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateWirelessGateway +func (c *IoTWireless) UpdateWirelessGateway(input *UpdateWirelessGatewayInput) (*UpdateWirelessGatewayOutput, error) { + req, out := c.UpdateWirelessGatewayRequest(input) + return out, req.Send() +} + +// UpdateWirelessGatewayWithContext is the same as UpdateWirelessGateway with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateWirelessGateway for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) UpdateWirelessGatewayWithContext(ctx aws.Context, input *UpdateWirelessGatewayInput, opts ...request.Option) (*UpdateWirelessGatewayOutput, error) { + req, out := c.UpdateWirelessGatewayRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ABP device object for LoRaWAN specification v1.0.x +type AbpV10X struct { + _ struct{} `type:"structure"` + + // The DevAddr value. + DevAddr *string `type:"string"` + + // The FCnt init value. + FCntStart *int64 `type:"integer"` + + // Session keys for ABP v1.0.x + SessionKeys *SessionKeysAbpV10X `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AbpV10X) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AbpV10X) GoString() string { + return s.String() +} + +// SetDevAddr sets the DevAddr field's value. +func (s *AbpV10X) SetDevAddr(v string) *AbpV10X { + s.DevAddr = &v + return s +} // SetFCntStart sets the FCntStart field's value. func (s *AbpV10X) SetFCntStart(v int64) *AbpV10X { @@ -11864,6 +12615,9 @@ type CreateDeviceProfileInput struct { // The name of the new resource. Name *string `type:"string"` + // The Sidewalk-related information for creating the Sidewalk device profile. + Sidewalk *SidewalkCreateDeviceProfile `type:"structure"` + // The tags to attach to the new device profile. Tags are metadata that you // can use to manage a resource. Tags []*Tag `type:"list"` @@ -11933,6 +12687,12 @@ func (s *CreateDeviceProfileInput) SetName(v string) *CreateDeviceProfileInput { return s } +// SetSidewalk sets the Sidewalk field's value. +func (s *CreateDeviceProfileInput) SetSidewalk(v *SidewalkCreateDeviceProfile) *CreateDeviceProfileInput { + s.Sidewalk = v + return s +} + // SetTags sets the Tags field's value. func (s *CreateDeviceProfileInput) SetTags(v []*Tag) *CreateDeviceProfileInput { s.Tags = v @@ -12642,6 +13402,9 @@ type CreateWirelessDeviceInput struct { // information. Positioning *string `type:"string" enum:"PositioningConfigStatus"` + // The device configuration information to use to create the Sidewalk device. + Sidewalk *SidewalkCreateWirelessDevice `type:"structure"` + // The tags to attach to the new wireless device. Tags are metadata that you // can use to manage a resource. Tags []*Tag `type:"list"` @@ -12740,6 +13503,12 @@ func (s *CreateWirelessDeviceInput) SetPositioning(v string) *CreateWirelessDevi return s } +// SetSidewalk sets the Sidewalk field's value. +func (s *CreateWirelessDeviceInput) SetSidewalk(v *SidewalkCreateWirelessDevice) *CreateWirelessDeviceInput { + s.Sidewalk = v + return s +} + // SetTags sets the Tags field's value. func (s *CreateWirelessDeviceInput) SetTags(v []*Tag) *CreateWirelessDeviceInput { s.Tags = v @@ -13183,6 +13952,78 @@ func (s *CreateWirelessGatewayTaskOutput) SetWirelessGatewayTaskDefinitionId(v s return s } +// The device attestation key (DAK) information. +type DakCertificateMetadata struct { + _ struct{} `type:"structure"` + + // The advertised product ID (APID) that's used for pre-production and production + // applications. + ApId *string `type:"string"` + + // The certificate ID for the DAK. + // + // CertificateId is a required field + CertificateId *string `type:"string" required:"true"` + + // The device type ID that's used for prototyping applications. + DeviceTypeId *string `type:"string"` + + // Whether factory support has been enabled. + FactorySupport *bool `type:"boolean"` + + // The maximum number of signatures that the DAK can sign. A value of -1 indicates + // that there's no device limit. + MaxAllowedSignature *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DakCertificateMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DakCertificateMetadata) GoString() string { + return s.String() +} + +// SetApId sets the ApId field's value. +func (s *DakCertificateMetadata) SetApId(v string) *DakCertificateMetadata { + s.ApId = &v + return s +} + +// SetCertificateId sets the CertificateId field's value. +func (s *DakCertificateMetadata) SetCertificateId(v string) *DakCertificateMetadata { + s.CertificateId = &v + return s +} + +// SetDeviceTypeId sets the DeviceTypeId field's value. +func (s *DakCertificateMetadata) SetDeviceTypeId(v string) *DakCertificateMetadata { + s.DeviceTypeId = &v + return s +} + +// SetFactorySupport sets the FactorySupport field's value. +func (s *DakCertificateMetadata) SetFactorySupport(v bool) *DakCertificateMetadata { + s.FactorySupport = &v + return s +} + +// SetMaxAllowedSignature sets the MaxAllowedSignature field's value. +func (s *DakCertificateMetadata) SetMaxAllowedSignature(v int64) *DakCertificateMetadata { + s.MaxAllowedSignature = &v + return s +} + type DeleteDestinationInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -13705,6 +14546,77 @@ func (s DeleteServiceProfileOutput) GoString() string { return s.String() } +type DeleteWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier of the import task to be deleted. + // + // Id is a required field + Id *string `location:"uri" locationName:"Id" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWirelessDeviceImportTaskInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DeleteWirelessDeviceImportTaskInput) SetId(v string) *DeleteWirelessDeviceImportTaskInput { + s.Id = &v + return s +} + +type DeleteWirelessDeviceImportTaskOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWirelessDeviceImportTaskOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWirelessDeviceImportTaskOutput) GoString() string { + return s.String() +} + type DeleteWirelessDeviceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -13989,27 +14901,108 @@ func (s DeleteWirelessGatewayTaskOutput) GoString() string { return s.String() } -// Describes a destination. -type Destinations struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name of the resource. - Arn *string `type:"string"` - - // The description of the resource. - Description *string `type:"string"` - - // The rule name or topic rule to send messages to. - Expression *string `type:"string"` - - // The type of value in Expression. - ExpressionType *string `type:"string" enum:"ExpressionType"` +type DeregisterWirelessDeviceInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // The name of the resource. - Name *string `type:"string"` + // The identifier of the wireless device to deregister from AWS IoT Wireless. + // + // Identifier is a required field + Identifier *string `location:"uri" locationName:"Identifier" type:"string" required:"true"` - // The ARN of the IAM Role that authorizes the destination. - RoleArn *string `min:"20" type:"string"` + // The type of wireless device to deregister from AWS IoT Wireless, which can + // be LoRaWAN or Sidewalk. + WirelessDeviceType *string `location:"querystring" locationName:"WirelessDeviceType" type:"string" enum:"WirelessDeviceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterWirelessDeviceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterWirelessDeviceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeregisterWirelessDeviceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeregisterWirelessDeviceInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *DeregisterWirelessDeviceInput) SetIdentifier(v string) *DeregisterWirelessDeviceInput { + s.Identifier = &v + return s +} + +// SetWirelessDeviceType sets the WirelessDeviceType field's value. +func (s *DeregisterWirelessDeviceInput) SetWirelessDeviceType(v string) *DeregisterWirelessDeviceInput { + s.WirelessDeviceType = &v + return s +} + +type DeregisterWirelessDeviceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterWirelessDeviceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterWirelessDeviceOutput) GoString() string { + return s.String() +} + +// Describes a destination. +type Destinations struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name of the resource. + Arn *string `type:"string"` + + // The description of the resource. + Description *string `type:"string"` + + // The rule name or topic rule to send messages to. + Expression *string `type:"string"` + + // The type of value in Expression. + ExpressionType *string `type:"string" enum:"ExpressionType"` + + // The name of the resource. + Name *string `type:"string"` + + // The ARN of the IAM Role that authorizes the destination. + RoleArn *string `min:"20" type:"string"` } // String returns the string representation. @@ -15353,6 +16346,9 @@ type GetDeviceProfileOutput struct { // The name of the resource. Name *string `type:"string"` + + // Information about the Sidewalk parameters in the device profile. + Sidewalk *SidewalkGetDeviceProfile `type:"structure"` } // String returns the string representation. @@ -15397,6 +16393,12 @@ func (s *GetDeviceProfileOutput) SetName(v string) *GetDeviceProfileOutput { return s } +// SetSidewalk sets the Sidewalk field's value. +func (s *GetDeviceProfileOutput) SetSidewalk(v *SidewalkGetDeviceProfile) *GetDeviceProfileOutput { + s.Sidewalk = v + return s +} + type GetEventConfigurationByResourceTypesInput struct { _ struct{} `type:"structure" nopayload:"true"` } @@ -17110,6 +18112,182 @@ func (s *GetServiceProfileOutput) SetName(v string) *GetServiceProfileOutput { return s } +type GetWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The identifier of the import task for which information is requested. + // + // Id is a required field + Id *string `location:"uri" locationName:"Id" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetWirelessDeviceImportTaskInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *GetWirelessDeviceImportTaskInput) SetId(v string) *GetWirelessDeviceImportTaskInput { + s.Id = &v + return s +} + +type GetWirelessDeviceImportTaskOutput struct { + _ struct{} `type:"structure"` + + // The ARN (Amazon Resource Name) of the import task. + Arn *string `type:"string"` + + // The time at which the import task was created. + CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The name of the destination that's assigned to the wireless devices in the + // import task. + DestinationName *string `type:"string"` + + // The number of devices in the import task that failed to onboard to the import + // task. + FailedImportedDeviceCount *int64 `type:"long"` + + // The identifier of the import task for which information is retrieved. + Id *string `type:"string"` + + // The number of devices in the import task that are waiting for the control + // log to start processing. + InitializedImportedDeviceCount *int64 `type:"long"` + + // The number of devices in the import task that have been onboarded to the + // import task. + OnboardedImportedDeviceCount *int64 `type:"long"` + + // The number of devices in the import task that are waiting in the import task + // queue to be onboarded. + PendingImportedDeviceCount *int64 `type:"long"` + + // The Sidewalk-related information about an import task. + Sidewalk *SidewalkGetStartImportInfo `type:"structure"` + + // The import task status. + Status *string `type:"string" enum:"ImportTaskStatus"` + + // The reason for the provided status information, such as a validation error + // that causes the import task to fail. + StatusReason *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetWirelessDeviceImportTaskOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetWirelessDeviceImportTaskOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetArn(v string) *GetWirelessDeviceImportTaskOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetCreationTime(v time.Time) *GetWirelessDeviceImportTaskOutput { + s.CreationTime = &v + return s +} + +// SetDestinationName sets the DestinationName field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetDestinationName(v string) *GetWirelessDeviceImportTaskOutput { + s.DestinationName = &v + return s +} + +// SetFailedImportedDeviceCount sets the FailedImportedDeviceCount field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetFailedImportedDeviceCount(v int64) *GetWirelessDeviceImportTaskOutput { + s.FailedImportedDeviceCount = &v + return s +} + +// SetId sets the Id field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetId(v string) *GetWirelessDeviceImportTaskOutput { + s.Id = &v + return s +} + +// SetInitializedImportedDeviceCount sets the InitializedImportedDeviceCount field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetInitializedImportedDeviceCount(v int64) *GetWirelessDeviceImportTaskOutput { + s.InitializedImportedDeviceCount = &v + return s +} + +// SetOnboardedImportedDeviceCount sets the OnboardedImportedDeviceCount field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetOnboardedImportedDeviceCount(v int64) *GetWirelessDeviceImportTaskOutput { + s.OnboardedImportedDeviceCount = &v + return s +} + +// SetPendingImportedDeviceCount sets the PendingImportedDeviceCount field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetPendingImportedDeviceCount(v int64) *GetWirelessDeviceImportTaskOutput { + s.PendingImportedDeviceCount = &v + return s +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetSidewalk(v *SidewalkGetStartImportInfo) *GetWirelessDeviceImportTaskOutput { + s.Sidewalk = v + return s +} + +// SetStatus sets the Status field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetStatus(v string) *GetWirelessDeviceImportTaskOutput { + s.Status = &v + return s +} + +// SetStatusReason sets the StatusReason field's value. +func (s *GetWirelessDeviceImportTaskOutput) SetStatusReason(v string) *GetWirelessDeviceImportTaskOutput { + s.StatusReason = &v + return s +} + type GetWirelessDeviceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -18514,12 +19692,21 @@ func (s *GsmObj) SetRxLevel(v int64) *GsmObj { return s } -// An unexpected error occurred while processing a request. -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// Information about a Sidewalk device that has been added to an import task. +type ImportedSidewalkDevice struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"Message" type:"string"` + // The time at which the status information was last updated. + LastUpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The onboarding status of the Sidewalk device in the import task. + OnboardingStatus *string `type:"string" enum:"OnboardStatus"` + + // The reason for the onboarding status information for the Sidewalk device. + OnboardingStatusReason *string `type:"string"` + + // The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device. + SidewalkManufacturingSn *string `type:"string"` } // String returns the string representation. @@ -18527,7 +19714,7 @@ type InternalServerException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) String() string { +func (s ImportedSidewalkDevice) String() string { return awsutil.Prettify(s) } @@ -18536,45 +19723,128 @@ func (s InternalServerException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) GoString() string { +func (s ImportedSidewalkDevice) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, - } +// SetLastUpdateTime sets the LastUpdateTime field's value. +func (s *ImportedSidewalkDevice) SetLastUpdateTime(v time.Time) *ImportedSidewalkDevice { + s.LastUpdateTime = &v + return s } -// Code returns the exception type name. -func (s *InternalServerException) Code() string { - return "InternalServerException" +// SetOnboardingStatus sets the OnboardingStatus field's value. +func (s *ImportedSidewalkDevice) SetOnboardingStatus(v string) *ImportedSidewalkDevice { + s.OnboardingStatus = &v + return s } -// Message returns the exception's message. -func (s *InternalServerException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetOnboardingStatusReason sets the OnboardingStatusReason field's value. +func (s *ImportedSidewalkDevice) SetOnboardingStatusReason(v string) *ImportedSidewalkDevice { + s.OnboardingStatusReason = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { - return nil +// SetSidewalkManufacturingSn sets the SidewalkManufacturingSn field's value. +func (s *ImportedSidewalkDevice) SetSidewalkManufacturingSn(v string) *ImportedSidewalkDevice { + s.SidewalkManufacturingSn = &v + return s } -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// Information about a wireless device that has been added to an import task. +type ImportedWirelessDevice struct { + _ struct{} `type:"structure"` + + // The Sidewalk-related information about a device that has been added to an + // import task. + Sidewalk *ImportedSidewalkDevice `type:"structure"` } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportedWirelessDevice) String() string { + return awsutil.Prettify(s) } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportedWirelessDevice) GoString() string { + return s.String() +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *ImportedWirelessDevice) SetSidewalk(v *ImportedSidewalkDevice) *ImportedWirelessDevice { + s.Sidewalk = v + return s +} + +// An unexpected error occurred while processing a request. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } @@ -18785,6 +20055,10 @@ func (s *ListDestinationsOutput) SetNextToken(v string) *ListDestinationsOutput type ListDeviceProfilesInput struct { _ struct{} `type:"structure" nopayload:"true"` + // A filter to list only device profiles that use this type, which can be LoRaWAN + // or Sidewalk. + DeviceProfileType *string `location:"querystring" locationName:"deviceProfileType" type:"string" enum:"DeviceProfileType"` + // The maximum number of results to return in this operation. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` @@ -18811,6 +20085,12 @@ func (s ListDeviceProfilesInput) GoString() string { return s.String() } +// SetDeviceProfileType sets the DeviceProfileType field's value. +func (s *ListDeviceProfilesInput) SetDeviceProfileType(v string) *ListDeviceProfilesInput { + s.DeviceProfileType = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListDeviceProfilesInput) SetMaxResults(v int64) *ListDeviceProfilesInput { s.MaxResults = &v @@ -18864,6 +20144,132 @@ func (s *ListDeviceProfilesOutput) SetNextToken(v string) *ListDeviceProfilesOut return s } +type ListDevicesForWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The identifier of the import task for which wireless devices are listed. + // + // Id is a required field + Id *string `location:"querystring" locationName:"id" type:"string" required:"true"` + + // The maximum number of results to return in this operation. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // To retrieve the next set of results, the nextToken value from a previous + // response; otherwise null to receive the first set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The status of the devices in the import task. + Status *string `location:"querystring" locationName:"status" type:"string" enum:"OnboardStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesForWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesForWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDevicesForWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDevicesForWirelessDeviceImportTaskInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *ListDevicesForWirelessDeviceImportTaskInput) SetId(v string) *ListDevicesForWirelessDeviceImportTaskInput { + s.Id = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDevicesForWirelessDeviceImportTaskInput) SetMaxResults(v int64) *ListDevicesForWirelessDeviceImportTaskInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesForWirelessDeviceImportTaskInput) SetNextToken(v string) *ListDevicesForWirelessDeviceImportTaskInput { + s.NextToken = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListDevicesForWirelessDeviceImportTaskInput) SetStatus(v string) *ListDevicesForWirelessDeviceImportTaskInput { + s.Status = &v + return s +} + +type ListDevicesForWirelessDeviceImportTaskOutput struct { + _ struct{} `type:"structure"` + + // The name of the Sidewalk destination that describes the IoT rule to route + // messages received from devices in an import task that are onboarded to AWS + // IoT Wireless. + DestinationName *string `type:"string"` + + // List of wireless devices in an import task and their onboarding status. + ImportedWirelessDeviceList []*ImportedWirelessDevice `type:"list"` + + // The token to use to get the next set of results, or null if there are no + // additional results. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesForWirelessDeviceImportTaskOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesForWirelessDeviceImportTaskOutput) GoString() string { + return s.String() +} + +// SetDestinationName sets the DestinationName field's value. +func (s *ListDevicesForWirelessDeviceImportTaskOutput) SetDestinationName(v string) *ListDevicesForWirelessDeviceImportTaskOutput { + s.DestinationName = &v + return s +} + +// SetImportedWirelessDeviceList sets the ImportedWirelessDeviceList field's value. +func (s *ListDevicesForWirelessDeviceImportTaskOutput) SetImportedWirelessDeviceList(v []*ImportedWirelessDevice) *ListDevicesForWirelessDeviceImportTaskOutput { + s.ImportedWirelessDeviceList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesForWirelessDeviceImportTaskOutput) SetNextToken(v string) *ListDevicesForWirelessDeviceImportTaskOutput { + s.NextToken = &v + return s +} + type ListEventConfigurationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -19782,6 +21188,89 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput return s } +type ListWirelessDeviceImportTasksInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return in this operation. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // To retrieve the next set of results, the nextToken value from a previous + // response; otherwise null to receive the first set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWirelessDeviceImportTasksInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWirelessDeviceImportTasksInput) GoString() string { + return s.String() +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListWirelessDeviceImportTasksInput) SetMaxResults(v int64) *ListWirelessDeviceImportTasksInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWirelessDeviceImportTasksInput) SetNextToken(v string) *ListWirelessDeviceImportTasksInput { + s.NextToken = &v + return s +} + +type ListWirelessDeviceImportTasksOutput struct { + _ struct{} `type:"structure"` + + // The token to use to get the next set of results, or null if there are no + // additional results. + NextToken *string `type:"string"` + + // List of import tasks and summary information of onboarding status of devices + // in each import task. + WirelessDeviceImportTaskList []*WirelessDeviceImportTask `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWirelessDeviceImportTasksOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWirelessDeviceImportTasksOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWirelessDeviceImportTasksOutput) SetNextToken(v string) *ListWirelessDeviceImportTasksOutput { + s.NextToken = &v + return s +} + +// SetWirelessDeviceImportTaskList sets the WirelessDeviceImportTaskList field's value. +func (s *ListWirelessDeviceImportTasksOutput) SetWirelessDeviceImportTaskList(v []*WirelessDeviceImportTask) *ListWirelessDeviceImportTasksOutput { + s.WirelessDeviceImportTaskList = v + return s +} + type ListWirelessDevicesInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -23814,21 +25303,88 @@ func (s *SidewalkAccountInfoWithFingerprint) SetFingerprint(v string) *SidewalkA return s } -// Sidewalk device object. -type SidewalkDevice struct { +// Sidewalk object for creating a device profile. +type SidewalkCreateDeviceProfile struct { _ struct{} `type:"structure"` +} - // The Sidewalk Amazon ID. - AmazonId *string `type:"string"` - - // The sidewalk device certificates for Ed25519 and P256r1. - DeviceCertificates []*CertificateList `type:"list"` - - // The sidewalk device identification. +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkCreateDeviceProfile) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkCreateDeviceProfile) GoString() string { + return s.String() +} + +// Sidewalk object for creating a wireless device. +type SidewalkCreateWirelessDevice struct { + _ struct{} `type:"structure"` + + // The ID of the Sidewalk device profile. + DeviceProfileId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkCreateWirelessDevice) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkCreateWirelessDevice) GoString() string { + return s.String() +} + +// SetDeviceProfileId sets the DeviceProfileId field's value. +func (s *SidewalkCreateWirelessDevice) SetDeviceProfileId(v string) *SidewalkCreateWirelessDevice { + s.DeviceProfileId = &v + return s +} + +// Sidewalk device object. +type SidewalkDevice struct { + _ struct{} `type:"structure"` + + // The Sidewalk Amazon ID. + AmazonId *string `type:"string"` + + // The ID of the Sidewalk device profile. + CertificateId *string `type:"string"` + + // The sidewalk device certificates for Ed25519 and P256r1. + DeviceCertificates []*CertificateList `type:"list"` + + // The ID of the Sidewalk device profile. + DeviceProfileId *string `type:"string"` + + // The Sidewalk device private keys that will be used for onboarding the device. + PrivateKeys []*CertificateList `type:"list"` + + // The sidewalk device identification. SidewalkId *string `type:"string"` // The Sidewalk manufacturing series number. SidewalkManufacturingSn *string `type:"string"` + + // The Sidewalk device status, such as provisioned or registered. + Status *string `type:"string" enum:"WirelessDeviceSidewalkStatus"` } // String returns the string representation. @@ -23855,12 +25411,30 @@ func (s *SidewalkDevice) SetAmazonId(v string) *SidewalkDevice { return s } +// SetCertificateId sets the CertificateId field's value. +func (s *SidewalkDevice) SetCertificateId(v string) *SidewalkDevice { + s.CertificateId = &v + return s +} + // SetDeviceCertificates sets the DeviceCertificates field's value. func (s *SidewalkDevice) SetDeviceCertificates(v []*CertificateList) *SidewalkDevice { s.DeviceCertificates = v return s } +// SetDeviceProfileId sets the DeviceProfileId field's value. +func (s *SidewalkDevice) SetDeviceProfileId(v string) *SidewalkDevice { + s.DeviceProfileId = &v + return s +} + +// SetPrivateKeys sets the PrivateKeys field's value. +func (s *SidewalkDevice) SetPrivateKeys(v []*CertificateList) *SidewalkDevice { + s.PrivateKeys = v + return s +} + // SetSidewalkId sets the SidewalkId field's value. func (s *SidewalkDevice) SetSidewalkId(v string) *SidewalkDevice { s.SidewalkId = &v @@ -23873,6 +25447,12 @@ func (s *SidewalkDevice) SetSidewalkManufacturingSn(v string) *SidewalkDevice { return s } +// SetStatus sets the Status field's value. +func (s *SidewalkDevice) SetStatus(v string) *SidewalkDevice { + s.Status = &v + return s +} + // MetaData for Sidewalk device. type SidewalkDeviceMetadata struct { _ struct{} `type:"structure"` @@ -23965,6 +25545,103 @@ func (s *SidewalkEventNotificationConfigurations) SetAmazonIdEventTopic(v string return s } +// Gets information about a Sidewalk device profile. +type SidewalkGetDeviceProfile struct { + _ struct{} `type:"structure"` + + // The Sidewalk application server public key. + // + // ApplicationServerPublicKey is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SidewalkGetDeviceProfile's + // String and GoString methods. + ApplicationServerPublicKey *string `min:"1" type:"string" sensitive:"true"` + + // The DAK certificate information of the Sidewalk device profile. + DakCertificateMetadata []*DakCertificateMetadata `type:"list"` + + // Gets information about the certification status of a Sidewalk device profile. + QualificationStatus *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkGetDeviceProfile) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkGetDeviceProfile) GoString() string { + return s.String() +} + +// SetApplicationServerPublicKey sets the ApplicationServerPublicKey field's value. +func (s *SidewalkGetDeviceProfile) SetApplicationServerPublicKey(v string) *SidewalkGetDeviceProfile { + s.ApplicationServerPublicKey = &v + return s +} + +// SetDakCertificateMetadata sets the DakCertificateMetadata field's value. +func (s *SidewalkGetDeviceProfile) SetDakCertificateMetadata(v []*DakCertificateMetadata) *SidewalkGetDeviceProfile { + s.DakCertificateMetadata = v + return s +} + +// SetQualificationStatus sets the QualificationStatus field's value. +func (s *SidewalkGetDeviceProfile) SetQualificationStatus(v bool) *SidewalkGetDeviceProfile { + s.QualificationStatus = &v + return s +} + +// Sidewalk-related information for devices in an import task that are being +// onboarded. +type SidewalkGetStartImportInfo struct { + _ struct{} `type:"structure"` + + // List of Sidewalk devices that are added to the import task. + DeviceCreationFileList []*string `type:"list"` + + // The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 + // bucket. + Role *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkGetStartImportInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkGetStartImportInfo) GoString() string { + return s.String() +} + +// SetDeviceCreationFileList sets the DeviceCreationFileList field's value. +func (s *SidewalkGetStartImportInfo) SetDeviceCreationFileList(v []*string) *SidewalkGetStartImportInfo { + s.DeviceCreationFileList = v + return s +} + +// SetRole sets the Role field's value. +func (s *SidewalkGetStartImportInfo) SetRole(v string) *SidewalkGetStartImportInfo { + s.Role = &v + return s +} + // Sidewalk object used by list functions. type SidewalkListDevice struct { _ struct{} `type:"structure"` @@ -23975,11 +25652,17 @@ type SidewalkListDevice struct { // The sidewalk device certificates for Ed25519 and P256r1. DeviceCertificates []*CertificateList `type:"list"` + // Sidewalk object used by list functions. + DeviceProfileId *string `type:"string"` + // The sidewalk device identification. SidewalkId *string `type:"string"` // The Sidewalk manufacturing series number. SidewalkManufacturingSn *string `type:"string"` + + // The status of the Sidewalk devices, such as provisioned or registered. + Status *string `type:"string" enum:"WirelessDeviceSidewalkStatus"` } // String returns the string representation. @@ -24012,6 +25695,12 @@ func (s *SidewalkListDevice) SetDeviceCertificates(v []*CertificateList) *Sidewa return s } +// SetDeviceProfileId sets the DeviceProfileId field's value. +func (s *SidewalkListDevice) SetDeviceProfileId(v string) *SidewalkListDevice { + s.DeviceProfileId = &v + return s +} + // SetSidewalkId sets the SidewalkId field's value. func (s *SidewalkListDevice) SetSidewalkId(v string) *SidewalkListDevice { s.SidewalkId = &v @@ -24024,6 +25713,12 @@ func (s *SidewalkListDevice) SetSidewalkManufacturingSn(v string) *SidewalkListD return s } +// SetStatus sets the Status field's value. +func (s *SidewalkListDevice) SetStatus(v string) *SidewalkListDevice { + s.Status = &v + return s +} + // Sidewalk resource type event configuration object for enabling or disabling // topic. type SidewalkResourceTypeEventConfiguration struct { @@ -24107,6 +25802,82 @@ func (s *SidewalkSendDataToDevice) SetSeq(v int64) *SidewalkSendDataToDevice { return s } +// Information about an import task created for an individual Sidewalk device. +type SidewalkSingleStartImportInfo struct { + _ struct{} `type:"structure"` + + // The Sidewalk manufacturing serial number (SMSN) of the device added to the + // import task. + SidewalkManufacturingSn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkSingleStartImportInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkSingleStartImportInfo) GoString() string { + return s.String() +} + +// SetSidewalkManufacturingSn sets the SidewalkManufacturingSn field's value. +func (s *SidewalkSingleStartImportInfo) SetSidewalkManufacturingSn(v string) *SidewalkSingleStartImportInfo { + s.SidewalkManufacturingSn = &v + return s +} + +// Information about an import task created for bulk provisioning. +type SidewalkStartImportInfo struct { + _ struct{} `type:"structure"` + + // The CSV file contained in an S3 bucket that's used for adding devices to + // an import task. + DeviceCreationFile *string `type:"string"` + + // The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 + // bucket. + Role *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkStartImportInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkStartImportInfo) GoString() string { + return s.String() +} + +// SetDeviceCreationFile sets the DeviceCreationFile field's value. +func (s *SidewalkStartImportInfo) SetDeviceCreationFile(v string) *SidewalkStartImportInfo { + s.DeviceCreationFile = &v + return s +} + +// SetRole sets the Role field's value. +func (s *SidewalkStartImportInfo) SetRole(v string) *SidewalkStartImportInfo { + s.Role = &v + return s +} + // Sidewalk update. type SidewalkUpdateAccount struct { _ struct{} `type:"structure"` @@ -24156,6 +25927,39 @@ func (s *SidewalkUpdateAccount) SetAppServerPrivateKey(v string) *SidewalkUpdate return s } +// Sidewalk object information for updating an import task. +type SidewalkUpdateImportInfo struct { + _ struct{} `type:"structure"` + + // The CSV file contained in an S3 bucket that's used for appending devices + // to an existing import task. + DeviceCreationFile *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkUpdateImportInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkUpdateImportInfo) GoString() string { + return s.String() +} + +// SetDeviceCreationFile sets the DeviceCreationFile field's value. +func (s *SidewalkUpdateImportInfo) SetDeviceCreationFile(v string) *SidewalkUpdateImportInfo { + s.DeviceCreationFile = &v + return s +} + type StartBulkAssociateWirelessDeviceWithMulticastGroupInput struct { _ struct{} `type:"structure"` @@ -24476,15 +26280,269 @@ func (s *StartMulticastGroupSessionInput) Validate() error { if s.Id == nil { invalidParams.Add(request.NewErrParamRequired("Id")) } - if s.Id != nil && len(*s.Id) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.LoRaWAN == nil { + invalidParams.Add(request.NewErrParamRequired("LoRaWAN")) + } + if s.LoRaWAN != nil { + if err := s.LoRaWAN.Validate(); err != nil { + invalidParams.AddNested("LoRaWAN", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *StartMulticastGroupSessionInput) SetId(v string) *StartMulticastGroupSessionInput { + s.Id = &v + return s +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *StartMulticastGroupSessionInput) SetLoRaWAN(v *LoRaWANMulticastSession) *StartMulticastGroupSessionInput { + s.LoRaWAN = v + return s +} + +type StartMulticastGroupSessionOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartMulticastGroupSessionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartMulticastGroupSessionOutput) GoString() string { + return s.String() +} + +type StartSingleWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure"` + + // Each resource must have a unique client request token. If you try to create + // a new resource with the same token as a resource that already exists, an + // exception occurs. If you omit this value, AWS SDKs will automatically generate + // a unique client request. + ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The name of the Sidewalk destination that describes the IoT rule to route + // messages from the device in the import task that will be onboarded to AWS + // IoT Wireless. + // + // DestinationName is a required field + DestinationName *string `type:"string" required:"true"` + + // The name of the wireless device for which an import task is being started. + DeviceName *string `type:"string"` + + // The Sidewalk-related parameters for importing a single wireless device. + // + // Sidewalk is a required field + Sidewalk *SidewalkSingleStartImportInfo `type:"structure" required:"true"` + + // The tag to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSingleWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSingleWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartSingleWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartSingleWirelessDeviceImportTaskInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DestinationName == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationName")) + } + if s.Sidewalk == nil { + invalidParams.Add(request.NewErrParamRequired("Sidewalk")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *StartSingleWirelessDeviceImportTaskInput) SetClientRequestToken(v string) *StartSingleWirelessDeviceImportTaskInput { + s.ClientRequestToken = &v + return s +} + +// SetDestinationName sets the DestinationName field's value. +func (s *StartSingleWirelessDeviceImportTaskInput) SetDestinationName(v string) *StartSingleWirelessDeviceImportTaskInput { + s.DestinationName = &v + return s +} + +// SetDeviceName sets the DeviceName field's value. +func (s *StartSingleWirelessDeviceImportTaskInput) SetDeviceName(v string) *StartSingleWirelessDeviceImportTaskInput { + s.DeviceName = &v + return s +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *StartSingleWirelessDeviceImportTaskInput) SetSidewalk(v *SidewalkSingleStartImportInfo) *StartSingleWirelessDeviceImportTaskInput { + s.Sidewalk = v + return s +} + +// SetTags sets the Tags field's value. +func (s *StartSingleWirelessDeviceImportTaskInput) SetTags(v []*Tag) *StartSingleWirelessDeviceImportTaskInput { + s.Tags = v + return s +} + +type StartSingleWirelessDeviceImportTaskOutput struct { + _ struct{} `type:"structure"` + + // The ARN (Amazon Resource Name) of the import task. + Arn *string `type:"string"` + + // The import task ID. + Id *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSingleWirelessDeviceImportTaskOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSingleWirelessDeviceImportTaskOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *StartSingleWirelessDeviceImportTaskOutput) SetArn(v string) *StartSingleWirelessDeviceImportTaskOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *StartSingleWirelessDeviceImportTaskOutput) SetId(v string) *StartSingleWirelessDeviceImportTaskOutput { + s.Id = &v + return s +} + +type StartWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure"` + + // Each resource must have a unique client request token. If you try to create + // a new resource with the same token as a resource that already exists, an + // exception occurs. If you omit this value, AWS SDKs will automatically generate + // a unique client request. + ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The name of the Sidewalk destination that describes the IoT rule to route + // messages from the devices in the import task that are onboarded to AWS IoT + // Wireless. + // + // DestinationName is a required field + DestinationName *string `type:"string" required:"true"` + + // The Sidewalk-related parameters for importing wireless devices that need + // to be provisioned in bulk. + // + // Sidewalk is a required field + Sidewalk *SidewalkStartImportInfo `type:"structure" required:"true"` + + // The tag to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartWirelessDeviceImportTaskInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DestinationName == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationName")) } - if s.LoRaWAN == nil { - invalidParams.Add(request.NewErrParamRequired("LoRaWAN")) + if s.Sidewalk == nil { + invalidParams.Add(request.NewErrParamRequired("Sidewalk")) } - if s.LoRaWAN != nil { - if err := s.LoRaWAN.Validate(); err != nil { - invalidParams.AddNested("LoRaWAN", err.(request.ErrInvalidParams)) + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } } } @@ -24494,20 +26552,38 @@ func (s *StartMulticastGroupSessionInput) Validate() error { return nil } -// SetId sets the Id field's value. -func (s *StartMulticastGroupSessionInput) SetId(v string) *StartMulticastGroupSessionInput { - s.Id = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *StartWirelessDeviceImportTaskInput) SetClientRequestToken(v string) *StartWirelessDeviceImportTaskInput { + s.ClientRequestToken = &v return s } -// SetLoRaWAN sets the LoRaWAN field's value. -func (s *StartMulticastGroupSessionInput) SetLoRaWAN(v *LoRaWANMulticastSession) *StartMulticastGroupSessionInput { - s.LoRaWAN = v +// SetDestinationName sets the DestinationName field's value. +func (s *StartWirelessDeviceImportTaskInput) SetDestinationName(v string) *StartWirelessDeviceImportTaskInput { + s.DestinationName = &v return s } -type StartMulticastGroupSessionOutput struct { +// SetSidewalk sets the Sidewalk field's value. +func (s *StartWirelessDeviceImportTaskInput) SetSidewalk(v *SidewalkStartImportInfo) *StartWirelessDeviceImportTaskInput { + s.Sidewalk = v + return s +} + +// SetTags sets the Tags field's value. +func (s *StartWirelessDeviceImportTaskInput) SetTags(v []*Tag) *StartWirelessDeviceImportTaskInput { + s.Tags = v + return s +} + +type StartWirelessDeviceImportTaskOutput struct { _ struct{} `type:"structure"` + + // The ARN (Amazon Resource Name) of the import task. + Arn *string `type:"string"` + + // The import task ID. + Id *string `type:"string"` } // String returns the string representation. @@ -24515,7 +26591,7 @@ type StartMulticastGroupSessionOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StartMulticastGroupSessionOutput) String() string { +func (s StartWirelessDeviceImportTaskOutput) String() string { return awsutil.Prettify(s) } @@ -24524,10 +26600,22 @@ func (s StartMulticastGroupSessionOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s StartMulticastGroupSessionOutput) GoString() string { +func (s StartWirelessDeviceImportTaskOutput) GoString() string { return s.String() } +// SetArn sets the Arn field's value. +func (s *StartWirelessDeviceImportTaskOutput) SetArn(v string) *StartWirelessDeviceImportTaskOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *StartWirelessDeviceImportTaskOutput) SetId(v string) *StartWirelessDeviceImportTaskOutput { + s.Id = &v + return s +} + // A simple label consisting of a customer-defined key-value pair type Tag struct { _ struct{} `type:"structure"` @@ -26619,6 +28707,91 @@ func (s UpdateResourcePositionOutput) GoString() string { return s.String() } +type UpdateWirelessDeviceImportTaskInput struct { + _ struct{} `type:"structure"` + + // The identifier of the import task to be updated. + // + // Id is a required field + Id *string `location:"uri" locationName:"Id" type:"string" required:"true"` + + // The Sidewalk-related parameters of the import task to be updated. + // + // Sidewalk is a required field + Sidewalk *SidewalkUpdateImportInfo `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateWirelessDeviceImportTaskInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateWirelessDeviceImportTaskInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateWirelessDeviceImportTaskInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateWirelessDeviceImportTaskInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.Sidewalk == nil { + invalidParams.Add(request.NewErrParamRequired("Sidewalk")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *UpdateWirelessDeviceImportTaskInput) SetId(v string) *UpdateWirelessDeviceImportTaskInput { + s.Id = &v + return s +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *UpdateWirelessDeviceImportTaskInput) SetSidewalk(v *SidewalkUpdateImportInfo) *UpdateWirelessDeviceImportTaskInput { + s.Sidewalk = v + return s +} + +type UpdateWirelessDeviceImportTaskOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateWirelessDeviceImportTaskOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateWirelessDeviceImportTaskOutput) GoString() string { + return s.String() +} + type UpdateWirelessDeviceInput struct { _ struct{} `type:"structure"` @@ -27355,7 +29528,7 @@ type WiFiAccessPoint struct { // MacAddress is a required field MacAddress *string `min:"12" type:"string" required:"true"` - // Recived signal strength of the WLAN measurement data. + // Received signal strength (dBm) of the WLAN measurement data. // // Rss is a required field Rss *int64 `type:"integer" required:"true"` @@ -27481,6 +29654,134 @@ func (s *WirelessDeviceEventLogOption) SetLogLevel(v string) *WirelessDeviceEven return s } +// Information about an import task for wireless devices. +type WirelessDeviceImportTask struct { + _ struct{} `type:"structure"` + + // The ARN (Amazon Resource Name) of the wireless device import task. + Arn *string `type:"string"` + + // The time at which the import task was created. + CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The name of the Sidewalk destination that that describes the IoT rule to + // route messages from the device in the import task that will be onboarded + // to AWS IoT Wireless + DestinationName *string `type:"string"` + + // The summary information of count of wireless devices in an import task that + // failed to onboarded to the import task. + FailedImportedDeviceCount *int64 `type:"long"` + + // The ID of the wireless device import task. + Id *string `type:"string"` + + // The summary information of count of wireless devices that are waiting for + // the control log to be added to an import task. + InitializedImportedDeviceCount *int64 `type:"long"` + + // The summary information of count of wireless devices in an import task that + // have been onboarded to the import task. + OnboardedImportedDeviceCount *int64 `type:"long"` + + // The summary information of count of wireless devices in an import task that + // are waiting in the queue to be onboarded. + PendingImportedDeviceCount *int64 `type:"long"` + + // The Sidewalk-related information of the wireless device import task. + Sidewalk *SidewalkGetStartImportInfo `type:"structure"` + + // The status information of the wireless device import task. + Status *string `type:"string" enum:"ImportTaskStatus"` + + // The reason that provides additional information about the import task status. + StatusReason *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WirelessDeviceImportTask) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WirelessDeviceImportTask) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *WirelessDeviceImportTask) SetArn(v string) *WirelessDeviceImportTask { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *WirelessDeviceImportTask) SetCreationTime(v time.Time) *WirelessDeviceImportTask { + s.CreationTime = &v + return s +} + +// SetDestinationName sets the DestinationName field's value. +func (s *WirelessDeviceImportTask) SetDestinationName(v string) *WirelessDeviceImportTask { + s.DestinationName = &v + return s +} + +// SetFailedImportedDeviceCount sets the FailedImportedDeviceCount field's value. +func (s *WirelessDeviceImportTask) SetFailedImportedDeviceCount(v int64) *WirelessDeviceImportTask { + s.FailedImportedDeviceCount = &v + return s +} + +// SetId sets the Id field's value. +func (s *WirelessDeviceImportTask) SetId(v string) *WirelessDeviceImportTask { + s.Id = &v + return s +} + +// SetInitializedImportedDeviceCount sets the InitializedImportedDeviceCount field's value. +func (s *WirelessDeviceImportTask) SetInitializedImportedDeviceCount(v int64) *WirelessDeviceImportTask { + s.InitializedImportedDeviceCount = &v + return s +} + +// SetOnboardedImportedDeviceCount sets the OnboardedImportedDeviceCount field's value. +func (s *WirelessDeviceImportTask) SetOnboardedImportedDeviceCount(v int64) *WirelessDeviceImportTask { + s.OnboardedImportedDeviceCount = &v + return s +} + +// SetPendingImportedDeviceCount sets the PendingImportedDeviceCount field's value. +func (s *WirelessDeviceImportTask) SetPendingImportedDeviceCount(v int64) *WirelessDeviceImportTask { + s.PendingImportedDeviceCount = &v + return s +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *WirelessDeviceImportTask) SetSidewalk(v *SidewalkGetStartImportInfo) *WirelessDeviceImportTask { + s.Sidewalk = v + return s +} + +// SetStatus sets the Status field's value. +func (s *WirelessDeviceImportTask) SetStatus(v string) *WirelessDeviceImportTask { + s.Status = &v + return s +} + +// SetStatusReason sets the StatusReason field's value. +func (s *WirelessDeviceImportTask) SetStatusReason(v string) *WirelessDeviceImportTask { + s.StatusReason = &v + return s +} + // The log options for wireless devices and can be used to set log levels for // a specific type of wireless device. type WirelessDeviceLogOption struct { @@ -28018,6 +30319,22 @@ func ConnectionStatus_Values() []string { } } +const ( + // DeviceProfileTypeSidewalk is a DeviceProfileType enum value + DeviceProfileTypeSidewalk = "Sidewalk" + + // DeviceProfileTypeLoRaWan is a DeviceProfileType enum value + DeviceProfileTypeLoRaWan = "LoRaWAN" +) + +// DeviceProfileType_Values returns all elements of the DeviceProfileType enum +func DeviceProfileType_Values() []string { + return []string{ + DeviceProfileTypeSidewalk, + DeviceProfileTypeLoRaWan, + } +} + // Device state defines the device status of sidewalk device. const ( // DeviceStateProvisioned is a DeviceState enum value @@ -28283,6 +30600,38 @@ func IdentifierType_Values() []string { } } +const ( + // ImportTaskStatusInitializing is a ImportTaskStatus enum value + ImportTaskStatusInitializing = "INITIALIZING" + + // ImportTaskStatusInitialized is a ImportTaskStatus enum value + ImportTaskStatusInitialized = "INITIALIZED" + + // ImportTaskStatusPending is a ImportTaskStatus enum value + ImportTaskStatusPending = "PENDING" + + // ImportTaskStatusComplete is a ImportTaskStatus enum value + ImportTaskStatusComplete = "COMPLETE" + + // ImportTaskStatusFailed is a ImportTaskStatus enum value + ImportTaskStatusFailed = "FAILED" + + // ImportTaskStatusDeleting is a ImportTaskStatus enum value + ImportTaskStatusDeleting = "DELETING" +) + +// ImportTaskStatus_Values returns all elements of the ImportTaskStatus enum +func ImportTaskStatus_Values() []string { + return []string{ + ImportTaskStatusInitializing, + ImportTaskStatusInitialized, + ImportTaskStatusPending, + ImportTaskStatusComplete, + ImportTaskStatusFailed, + ImportTaskStatusDeleting, + } +} + // The log level for a log message. The log levels can be disabled, or set to // ERROR to display less verbose logs containing only error information, or // to INFO for more detailed logs. @@ -28331,6 +30680,30 @@ func MessageType_Values() []string { } } +const ( + // OnboardStatusInitialized is a OnboardStatus enum value + OnboardStatusInitialized = "INITIALIZED" + + // OnboardStatusPending is a OnboardStatus enum value + OnboardStatusPending = "PENDING" + + // OnboardStatusOnboarded is a OnboardStatus enum value + OnboardStatusOnboarded = "ONBOARDED" + + // OnboardStatusFailed is a OnboardStatus enum value + OnboardStatusFailed = "FAILED" +) + +// OnboardStatus_Values returns all elements of the OnboardStatus enum +func OnboardStatus_Values() []string { + return []string{ + OnboardStatusInitialized, + OnboardStatusPending, + OnboardStatusOnboarded, + OnboardStatusFailed, + } +} + const ( // PartnerTypeSidewalk is a PartnerType enum value PartnerTypeSidewalk = "Sidewalk" @@ -28461,6 +30834,33 @@ const ( // SupportedRfRegionAs9231 is a SupportedRfRegion enum value SupportedRfRegionAs9231 = "AS923-1" + + // SupportedRfRegionAs9232 is a SupportedRfRegion enum value + SupportedRfRegionAs9232 = "AS923-2" + + // SupportedRfRegionAs9233 is a SupportedRfRegion enum value + SupportedRfRegionAs9233 = "AS923-3" + + // SupportedRfRegionAs9234 is a SupportedRfRegion enum value + SupportedRfRegionAs9234 = "AS923-4" + + // SupportedRfRegionEu433 is a SupportedRfRegion enum value + SupportedRfRegionEu433 = "EU433" + + // SupportedRfRegionCn470 is a SupportedRfRegion enum value + SupportedRfRegionCn470 = "CN470" + + // SupportedRfRegionCn779 is a SupportedRfRegion enum value + SupportedRfRegionCn779 = "CN779" + + // SupportedRfRegionRu864 is a SupportedRfRegion enum value + SupportedRfRegionRu864 = "RU864" + + // SupportedRfRegionKr920 is a SupportedRfRegion enum value + SupportedRfRegionKr920 = "KR920" + + // SupportedRfRegionIn865 is a SupportedRfRegion enum value + SupportedRfRegionIn865 = "IN865" ) // SupportedRfRegion_Values returns all elements of the SupportedRfRegion enum @@ -28470,6 +30870,15 @@ func SupportedRfRegion_Values() []string { SupportedRfRegionUs915, SupportedRfRegionAu915, SupportedRfRegionAs9231, + SupportedRfRegionAs9232, + SupportedRfRegionAs9233, + SupportedRfRegionAs9234, + SupportedRfRegionEu433, + SupportedRfRegionCn470, + SupportedRfRegionCn779, + SupportedRfRegionRu864, + SupportedRfRegionKr920, + SupportedRfRegionIn865, } } @@ -28545,6 +30954,30 @@ func WirelessDeviceIdType_Values() []string { } } +const ( + // WirelessDeviceSidewalkStatusProvisioned is a WirelessDeviceSidewalkStatus enum value + WirelessDeviceSidewalkStatusProvisioned = "PROVISIONED" + + // WirelessDeviceSidewalkStatusRegistered is a WirelessDeviceSidewalkStatus enum value + WirelessDeviceSidewalkStatusRegistered = "REGISTERED" + + // WirelessDeviceSidewalkStatusActivated is a WirelessDeviceSidewalkStatus enum value + WirelessDeviceSidewalkStatusActivated = "ACTIVATED" + + // WirelessDeviceSidewalkStatusUnknown is a WirelessDeviceSidewalkStatus enum value + WirelessDeviceSidewalkStatusUnknown = "UNKNOWN" +) + +// WirelessDeviceSidewalkStatus_Values returns all elements of the WirelessDeviceSidewalkStatus enum +func WirelessDeviceSidewalkStatus_Values() []string { + return []string{ + WirelessDeviceSidewalkStatusProvisioned, + WirelessDeviceSidewalkStatusRegistered, + WirelessDeviceSidewalkStatusActivated, + WirelessDeviceSidewalkStatusUnknown, + } +} + const ( // WirelessDeviceTypeSidewalk is a WirelessDeviceType enum value WirelessDeviceTypeSidewalk = "Sidewalk" diff --git a/service/iotwireless/iotwirelessiface/interface.go b/service/iotwireless/iotwirelessiface/interface.go index 612e912e507..4077f30deb1 100644 --- a/service/iotwireless/iotwirelessiface/interface.go +++ b/service/iotwireless/iotwirelessiface/interface.go @@ -164,6 +164,10 @@ type IoTWirelessAPI interface { DeleteWirelessDeviceWithContext(aws.Context, *iotwireless.DeleteWirelessDeviceInput, ...request.Option) (*iotwireless.DeleteWirelessDeviceOutput, error) DeleteWirelessDeviceRequest(*iotwireless.DeleteWirelessDeviceInput) (*request.Request, *iotwireless.DeleteWirelessDeviceOutput) + DeleteWirelessDeviceImportTask(*iotwireless.DeleteWirelessDeviceImportTaskInput) (*iotwireless.DeleteWirelessDeviceImportTaskOutput, error) + DeleteWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.DeleteWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.DeleteWirelessDeviceImportTaskOutput, error) + DeleteWirelessDeviceImportTaskRequest(*iotwireless.DeleteWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.DeleteWirelessDeviceImportTaskOutput) + DeleteWirelessGateway(*iotwireless.DeleteWirelessGatewayInput) (*iotwireless.DeleteWirelessGatewayOutput, error) DeleteWirelessGatewayWithContext(aws.Context, *iotwireless.DeleteWirelessGatewayInput, ...request.Option) (*iotwireless.DeleteWirelessGatewayOutput, error) DeleteWirelessGatewayRequest(*iotwireless.DeleteWirelessGatewayInput) (*request.Request, *iotwireless.DeleteWirelessGatewayOutput) @@ -176,6 +180,10 @@ type IoTWirelessAPI interface { DeleteWirelessGatewayTaskDefinitionWithContext(aws.Context, *iotwireless.DeleteWirelessGatewayTaskDefinitionInput, ...request.Option) (*iotwireless.DeleteWirelessGatewayTaskDefinitionOutput, error) DeleteWirelessGatewayTaskDefinitionRequest(*iotwireless.DeleteWirelessGatewayTaskDefinitionInput) (*request.Request, *iotwireless.DeleteWirelessGatewayTaskDefinitionOutput) + DeregisterWirelessDevice(*iotwireless.DeregisterWirelessDeviceInput) (*iotwireless.DeregisterWirelessDeviceOutput, error) + DeregisterWirelessDeviceWithContext(aws.Context, *iotwireless.DeregisterWirelessDeviceInput, ...request.Option) (*iotwireless.DeregisterWirelessDeviceOutput, error) + DeregisterWirelessDeviceRequest(*iotwireless.DeregisterWirelessDeviceInput) (*request.Request, *iotwireless.DeregisterWirelessDeviceOutput) + DisassociateAwsAccountFromPartnerAccount(*iotwireless.DisassociateAwsAccountFromPartnerAccountInput) (*iotwireless.DisassociateAwsAccountFromPartnerAccountOutput, error) DisassociateAwsAccountFromPartnerAccountWithContext(aws.Context, *iotwireless.DisassociateAwsAccountFromPartnerAccountInput, ...request.Option) (*iotwireless.DisassociateAwsAccountFromPartnerAccountOutput, error) DisassociateAwsAccountFromPartnerAccountRequest(*iotwireless.DisassociateAwsAccountFromPartnerAccountInput) (*request.Request, *iotwireless.DisassociateAwsAccountFromPartnerAccountOutput) @@ -276,6 +284,10 @@ type IoTWirelessAPI interface { GetWirelessDeviceWithContext(aws.Context, *iotwireless.GetWirelessDeviceInput, ...request.Option) (*iotwireless.GetWirelessDeviceOutput, error) GetWirelessDeviceRequest(*iotwireless.GetWirelessDeviceInput) (*request.Request, *iotwireless.GetWirelessDeviceOutput) + GetWirelessDeviceImportTask(*iotwireless.GetWirelessDeviceImportTaskInput) (*iotwireless.GetWirelessDeviceImportTaskOutput, error) + GetWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.GetWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.GetWirelessDeviceImportTaskOutput, error) + GetWirelessDeviceImportTaskRequest(*iotwireless.GetWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.GetWirelessDeviceImportTaskOutput) + GetWirelessDeviceStatistics(*iotwireless.GetWirelessDeviceStatisticsInput) (*iotwireless.GetWirelessDeviceStatisticsOutput, error) GetWirelessDeviceStatisticsWithContext(aws.Context, *iotwireless.GetWirelessDeviceStatisticsInput, ...request.Option) (*iotwireless.GetWirelessDeviceStatisticsOutput, error) GetWirelessDeviceStatisticsRequest(*iotwireless.GetWirelessDeviceStatisticsInput) (*request.Request, *iotwireless.GetWirelessDeviceStatisticsOutput) @@ -318,6 +330,10 @@ type IoTWirelessAPI interface { ListDeviceProfilesPages(*iotwireless.ListDeviceProfilesInput, func(*iotwireless.ListDeviceProfilesOutput, bool) bool) error ListDeviceProfilesPagesWithContext(aws.Context, *iotwireless.ListDeviceProfilesInput, func(*iotwireless.ListDeviceProfilesOutput, bool) bool, ...request.Option) error + ListDevicesForWirelessDeviceImportTask(*iotwireless.ListDevicesForWirelessDeviceImportTaskInput) (*iotwireless.ListDevicesForWirelessDeviceImportTaskOutput, error) + ListDevicesForWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.ListDevicesForWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.ListDevicesForWirelessDeviceImportTaskOutput, error) + ListDevicesForWirelessDeviceImportTaskRequest(*iotwireless.ListDevicesForWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.ListDevicesForWirelessDeviceImportTaskOutput) + ListEventConfigurations(*iotwireless.ListEventConfigurationsInput) (*iotwireless.ListEventConfigurationsOutput, error) ListEventConfigurationsWithContext(aws.Context, *iotwireless.ListEventConfigurationsInput, ...request.Option) (*iotwireless.ListEventConfigurationsOutput, error) ListEventConfigurationsRequest(*iotwireless.ListEventConfigurationsInput) (*request.Request, *iotwireless.ListEventConfigurationsOutput) @@ -379,6 +395,10 @@ type IoTWirelessAPI interface { ListTagsForResourceWithContext(aws.Context, *iotwireless.ListTagsForResourceInput, ...request.Option) (*iotwireless.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*iotwireless.ListTagsForResourceInput) (*request.Request, *iotwireless.ListTagsForResourceOutput) + ListWirelessDeviceImportTasks(*iotwireless.ListWirelessDeviceImportTasksInput) (*iotwireless.ListWirelessDeviceImportTasksOutput, error) + ListWirelessDeviceImportTasksWithContext(aws.Context, *iotwireless.ListWirelessDeviceImportTasksInput, ...request.Option) (*iotwireless.ListWirelessDeviceImportTasksOutput, error) + ListWirelessDeviceImportTasksRequest(*iotwireless.ListWirelessDeviceImportTasksInput) (*request.Request, *iotwireless.ListWirelessDeviceImportTasksOutput) + ListWirelessDevices(*iotwireless.ListWirelessDevicesInput) (*iotwireless.ListWirelessDevicesOutput, error) ListWirelessDevicesWithContext(aws.Context, *iotwireless.ListWirelessDevicesInput, ...request.Option) (*iotwireless.ListWirelessDevicesOutput, error) ListWirelessDevicesRequest(*iotwireless.ListWirelessDevicesInput) (*request.Request, *iotwireless.ListWirelessDevicesOutput) @@ -437,6 +457,14 @@ type IoTWirelessAPI interface { StartMulticastGroupSessionWithContext(aws.Context, *iotwireless.StartMulticastGroupSessionInput, ...request.Option) (*iotwireless.StartMulticastGroupSessionOutput, error) StartMulticastGroupSessionRequest(*iotwireless.StartMulticastGroupSessionInput) (*request.Request, *iotwireless.StartMulticastGroupSessionOutput) + StartSingleWirelessDeviceImportTask(*iotwireless.StartSingleWirelessDeviceImportTaskInput) (*iotwireless.StartSingleWirelessDeviceImportTaskOutput, error) + StartSingleWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.StartSingleWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.StartSingleWirelessDeviceImportTaskOutput, error) + StartSingleWirelessDeviceImportTaskRequest(*iotwireless.StartSingleWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.StartSingleWirelessDeviceImportTaskOutput) + + StartWirelessDeviceImportTask(*iotwireless.StartWirelessDeviceImportTaskInput) (*iotwireless.StartWirelessDeviceImportTaskOutput, error) + StartWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.StartWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.StartWirelessDeviceImportTaskOutput, error) + StartWirelessDeviceImportTaskRequest(*iotwireless.StartWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.StartWirelessDeviceImportTaskOutput) + TagResource(*iotwireless.TagResourceInput) (*iotwireless.TagResourceOutput, error) TagResourceWithContext(aws.Context, *iotwireless.TagResourceInput, ...request.Option) (*iotwireless.TagResourceOutput, error) TagResourceRequest(*iotwireless.TagResourceInput) (*request.Request, *iotwireless.TagResourceOutput) @@ -493,6 +521,10 @@ type IoTWirelessAPI interface { UpdateWirelessDeviceWithContext(aws.Context, *iotwireless.UpdateWirelessDeviceInput, ...request.Option) (*iotwireless.UpdateWirelessDeviceOutput, error) UpdateWirelessDeviceRequest(*iotwireless.UpdateWirelessDeviceInput) (*request.Request, *iotwireless.UpdateWirelessDeviceOutput) + UpdateWirelessDeviceImportTask(*iotwireless.UpdateWirelessDeviceImportTaskInput) (*iotwireless.UpdateWirelessDeviceImportTaskOutput, error) + UpdateWirelessDeviceImportTaskWithContext(aws.Context, *iotwireless.UpdateWirelessDeviceImportTaskInput, ...request.Option) (*iotwireless.UpdateWirelessDeviceImportTaskOutput, error) + UpdateWirelessDeviceImportTaskRequest(*iotwireless.UpdateWirelessDeviceImportTaskInput) (*request.Request, *iotwireless.UpdateWirelessDeviceImportTaskOutput) + UpdateWirelessGateway(*iotwireless.UpdateWirelessGatewayInput) (*iotwireless.UpdateWirelessGatewayOutput, error) UpdateWirelessGatewayWithContext(aws.Context, *iotwireless.UpdateWirelessGatewayInput, ...request.Option) (*iotwireless.UpdateWirelessGatewayOutput, error) UpdateWirelessGatewayRequest(*iotwireless.UpdateWirelessGatewayInput) (*request.Request, *iotwireless.UpdateWirelessGatewayOutput) diff --git a/service/medialive/api.go b/service/medialive/api.go index ff3997c5f98..5384e226e1c 100644 --- a/service/medialive/api.go +++ b/service/medialive/api.go @@ -12545,6 +12545,8 @@ type DescribeInputDeviceOutput struct { SerialNumber *string `locationName:"serialNumber" type:"string"` + Tags map[string]*string `locationName:"tags" type:"map"` + // The type of the input device. For an AWS Elemental Link device that outputs // resolutions up to 1080, choose "HD". Type *string `locationName:"type" type:"string" enum:"InputDeviceType"` @@ -12632,6 +12634,12 @@ func (s *DescribeInputDeviceOutput) SetSerialNumber(v string) *DescribeInputDevi return s } +// SetTags sets the Tags field's value. +func (s *DescribeInputDeviceOutput) SetTags(v map[string]*string) *DescribeInputDeviceOutput { + s.Tags = v + return s +} + // SetType sets the Type field's value. func (s *DescribeInputDeviceOutput) SetType(v string) *DescribeInputDeviceOutput { s.Type = &v @@ -18086,12 +18094,13 @@ func (s *HlsGroupSettings) SetTsFileMode(v string) *HlsGroupSettings { type HlsId3SegmentTaggingScheduleActionSettings struct { _ struct{} `type:"structure"` + // Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure + Id3 *string `locationName:"id3" type:"string"` + // ID3 tag to insert into each segment. Supports special keyword identifiers // to substitute in segment-related values.\nSupported keyword identifiers: // https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html - // - // Tag is a required field - Tag *string `locationName:"tag" type:"string" required:"true"` + Tag *string `locationName:"tag" type:"string"` } // String returns the string representation. @@ -18112,17 +18121,10 @@ func (s HlsId3SegmentTaggingScheduleActionSettings) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *HlsId3SegmentTaggingScheduleActionSettings) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "HlsId3SegmentTaggingScheduleActionSettings"} - if s.Tag == nil { - invalidParams.Add(request.NewErrParamRequired("Tag")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetId3 sets the Id3 field's value. +func (s *HlsId3SegmentTaggingScheduleActionSettings) SetId3(v string) *HlsId3SegmentTaggingScheduleActionSettings { + s.Id3 = &v + return s } // SetTag sets the Tag field's value. @@ -19496,6 +19498,9 @@ type InputDeviceSummary struct { // The unique serial number of the input device. SerialNumber *string `locationName:"serialNumber" type:"string"` + // A collection of key-value pairs. + Tags map[string]*string `locationName:"tags" type:"map"` + // The type of the input device. Type *string `locationName:"type" type:"string" enum:"InputDeviceType"` @@ -19581,6 +19586,12 @@ func (s *InputDeviceSummary) SetSerialNumber(v string) *InputDeviceSummary { return s } +// SetTags sets the Tags field's value. +func (s *InputDeviceSummary) SetTags(v map[string]*string) *InputDeviceSummary { + s.Tags = v + return s +} + // SetType sets the Type field's value. func (s *InputDeviceSummary) SetType(v string) *InputDeviceSummary { s.Type = &v @@ -27178,11 +27189,6 @@ func (s ScheduleActionSettings) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ScheduleActionSettings) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ScheduleActionSettings"} - if s.HlsId3SegmentTaggingSettings != nil { - if err := s.HlsId3SegmentTaggingSettings.Validate(); err != nil { - invalidParams.AddNested("HlsId3SegmentTaggingSettings", err.(request.ErrInvalidParams)) - } - } if s.HlsTimedMetadataSettings != nil { if err := s.HlsTimedMetadataSettings.Validate(); err != nil { invalidParams.AddNested("HlsTimedMetadataSettings", err.(request.ErrInvalidParams)) @@ -30665,6 +30671,8 @@ type UpdateInputDeviceOutput struct { SerialNumber *string `locationName:"serialNumber" type:"string"` + Tags map[string]*string `locationName:"tags" type:"map"` + // The type of the input device. For an AWS Elemental Link device that outputs // resolutions up to 1080, choose "HD". Type *string `locationName:"type" type:"string" enum:"InputDeviceType"` @@ -30752,6 +30760,12 @@ func (s *UpdateInputDeviceOutput) SetSerialNumber(v string) *UpdateInputDeviceOu return s } +// SetTags sets the Tags field's value. +func (s *UpdateInputDeviceOutput) SetTags(v map[string]*string) *UpdateInputDeviceOutput { + s.Tags = v + return s +} + // SetType sets the Type field's value. func (s *UpdateInputDeviceOutput) SetType(v string) *UpdateInputDeviceOutput { s.Type = &v diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index ca4d10c1345..5bfc37885cd 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -803,7 +803,8 @@ func (c *SageMaker) CreateAutoMLJobRequest(input *CreateAutoMLJobInput) (req *re // // Creates an Autopilot job. // -// Find the best-performing model after you run an Autopilot job by calling . +// Find the best-performing model after you run an Autopilot job by calling +// DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) . // // For information about how to use Autopilot, see Automate Model Development // with Amazon SageMaker Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html). @@ -892,9 +893,10 @@ func (c *SageMaker) CreateAutoMLJobV2Request(input *CreateAutoMLJobV2Input) (req // Creates an Amazon SageMaker AutoML job that uses non-tabular data such as // images or text for Computer Vision or Natural Language Processing problems. // -// Find the resulting model after you run an AutoML job V2 by calling . +// Find the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2 +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) . // -// To create an AutoMLJob using tabular data, see . +// To create an AutoMLJob using tabular data, see CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) . // // This API action is callable through SageMaker Canvas only. Calling it directly // from the CLI or an SDK results in an error. @@ -31583,7 +31585,8 @@ type AutoMLCandidateGenerationConfig struct { // * When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig // uses the full set of algorithms for the given training mode. // - // For the list of all algorithms per training mode, see . + // For the list of all algorithms per training mode, see AutoMLAlgorithmConfig + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html) . // // For more information on each algorithm, see the Algorithm support (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support) // section in Autopilot developer guide. @@ -31727,7 +31730,7 @@ func (s *AutoMLCandidateStep) SetCandidateStepType(v string) *AutoMLCandidateSte // A channel is a named input source that training algorithms can consume. The // validation dataset size is limited to less than 2 GB. The training dataset -// size must be less than 100 GB. For more information, see . +// size must be less than 100 GB. For more information, see Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) . // // A validation dataset must contain the same headers as the training dataset. type AutoMLChannel struct { @@ -31831,21 +31834,23 @@ func (s *AutoMLChannel) SetTargetAttributeName(v string) *AutoMLChannel { } // A list of container definitions that describe the different containers that -// make up an AutoML candidate. For more information, see . +// make up an AutoML candidate. For more information, see ContainerDefinition +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) . type AutoMLContainerDefinition struct { _ struct{} `type:"structure"` // The environment variables to set in the container. For more information, - // see . + // see ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) . Environment map[string]*string `type:"map"` // The Amazon Elastic Container Registry (Amazon ECR) path of the container. - // For more information, see . + // For more information, see ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) . // // Image is a required field Image *string `type:"string" required:"true"` - // The location of the model artifacts. For more information, see . + // The location of the model artifacts. For more information, see ContainerDefinition + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) . // // ModelDataUrl is a required field ModelDataUrl *string `type:"string" required:"true"` @@ -32024,7 +32029,8 @@ func (s *AutoMLJobArtifacts) SetDataExplorationNotebookLocation(v string) *AutoM // A channel is a named input source that training algorithms can consume. This // channel is used for the non tabular training data of an AutoML job using -// the V2 API. For tabular training data, see . For more information, see . +// the V2 API. For tabular training data, see AutoMLChannel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLChannel.html) +// . For more information, see Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) . type AutoMLJobChannel struct { _ struct{} `type:"structure"` @@ -32129,7 +32135,9 @@ type AutoMLJobCompletionCriteria struct { // The maximum time, in seconds, that each training job executed inside hyperparameter // tuning is allowed to run as part of a hyperparameter tuning job. For more - // information, see the used by the action. + // information, see the StoppingCondition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html) + // used by the CreateHyperParameterTuningJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) + // action. // // For V2 jobs (jobs created by calling CreateAutoMLJobV2), this field controls // the runtime of the job candidate. @@ -37152,8 +37160,10 @@ type CreateAutoMLJobInput struct { AutoMLJobName *string `min:"1" type:"string" required:"true"` // Defines the objective metric used to measure the predictive quality of an - // AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers - // whether to minimize or maximize it. For , only Accuracy is supported. + // AutoML job. You provide an AutoMLJobObjective$MetricName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) + // and Autopilot infers whether to minimize or maximize it. For CreateAutoMLJobV2 + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) + // , only Accuracy is supported. AutoMLJobObjective *AutoMLJobObjective `type:"structure"` // Generates possible candidates without training the models. A candidate is @@ -37163,9 +37173,10 @@ type CreateAutoMLJobInput struct { // An array of channel objects that describes the input data and its location. // Each channel is a named input source. Similar to InputDataConfig supported - // by . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required - // for the training dataset. There is not a minimum number of rows required - // for the validation dataset. + // by HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for + // the training dataset. There is not a minimum number of rows required for + // the validation dataset. // // InputDataConfig is a required field InputDataConfig []*AutoMLChannel `min:"1" type:"list" required:"true"` @@ -37181,8 +37192,7 @@ type CreateAutoMLJobInput struct { OutputDataConfig *AutoMLOutputDataConfig `type:"structure" required:"true"` // Defines the type of supervised learning problem available for the candidates. - // For more information, see Amazon SageMaker Autopilot problem types and algorithm - // support (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-problem-types.html). + // For more information, see Amazon SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types). ProblemType *string `type:"string" enum:"ProblemType"` // The ARN of the role that is used to access the data. @@ -37397,6 +37407,7 @@ type CreateAutoMLJobV2Input struct { AutoMLJobName *string `min:"1" type:"string" required:"true"` // Specifies a metric to minimize or maximize as the objective of a job. For + // CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) // , only Accuracy is supported. AutoMLJobObjective *AutoMLJobObjective `type:"structure"` @@ -67906,7 +67917,7 @@ type FinalAutoMLJobObjectiveMetric struct { _ struct{} `type:"structure"` // The name of the metric with the best result. For a description of the possible - // objective metrics, see AutoMLJobObjective$MetricName. + // objective metrics, see AutoMLJobObjective$MetricName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) . // // MetricName is a required field MetricName *string `type:"string" required:"true" enum:"AutoMLMetricEnum"` @@ -70804,7 +70815,7 @@ type HyperParameterTrainingJobDefinition struct { // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // API. You can use an existing environment variable from the training container // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment) - // or use your own. See Define metrics and variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html) + // or use your own. See Define metrics and variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) // for more information. // // The maximum number of items specified for Map Entries refers to the maximum @@ -72339,7 +72350,8 @@ type HyperbandStrategyConfig struct { // value, it is stopped. If a value for MaxResource is not provided, and Hyperband // is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts // to infer MaxResource from the following keys (if present) in StaticsHyperParameters - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters): + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters) + // : // // * epochs // @@ -86881,9 +86893,12 @@ func (s *MetricDatum) SetValue(v float64) *MetricDatum { } // Specifies a metric that the training algorithm writes to stderr or stdout. -// SageMakerhyperparameter tuning captures all defined metrics. You specify -// one metric that a hyperparameter tuning job uses as its objective metric -// to choose the best training job. +// You can view these logs to understand how your training job performs and +// check for any errors encountered during training. SageMaker hyperparameter +// tuning captures all defined metrics. Specify one of the defined metrics to +// use as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective) +// parameter in the HyperParameterTrainingJobDefinition API to evaluate job +// performance during hyperparameter tuning. type MetricDefinition struct { _ struct{} `type:"structure"` @@ -86894,7 +86909,7 @@ type MetricDefinition struct { // A regular expression that searches the output of a training job and gets // the value of the metric. For more information about using regular expressions - // to define metrics, see Defining Objective Metrics (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html). + // to define metrics, see Defining metrics and environment variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). // // Regex is a required field Regex *string `min:"1" type:"string" required:"true"` diff --git a/service/securityhub/api.go b/service/securityhub/api.go index 99caaecd11d..8d046d643db 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -1433,8 +1433,11 @@ func (c *SecurityHub) DeclineInvitationsRequest(input *DeclineInvitationsInput) // // Declines invitations to become a member account. // -// This operation is only used by accounts that are not part of an organization. -// Organization accounts do not receive invitations. +// A prospective member account uses this operation to decline an invitation +// to become a member. +// +// This operation is only called by member accounts that aren't part of an organization. +// Organization accounts don't receive invitations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1815,8 +1818,12 @@ func (c *SecurityHub) DeleteInvitationsRequest(input *DeleteInvitationsInput) (r // Deletes invitations received by the Amazon Web Services account to become // a member account. // -// This operation is only used by accounts that are not part of an organization. -// Organization accounts do not receive invitations. +// A Security Hub administrator account can use this operation to delete invitations +// sent to one or more member accounts. +// +// This operation is only used to delete invitations that are sent to member +// accounts that aren't part of an organization. Organization accounts don't +// receive invitations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7536,6 +7543,125 @@ func (s *AssociatedStandard) SetStandardsId(v string) *AssociatedStandard { return s } +// The associations between a route table and one or more subnets or a gateway. +type AssociationSetDetails struct { + _ struct{} `type:"structure"` + + // The state of the association between a route table and a subnet or gateway. + AssociationState *AssociationStateDetails `type:"structure"` + + // The ID of the internet gateway or virtual private gateway. + GatewayId *string `type:"string"` + + // Indicates whether this is the main route table. + Main *bool `type:"boolean"` + + // The ID of the association. + RouteTableAssociationId *string `type:"string"` + + // The ID of the route table. + RouteTableId *string `type:"string"` + + // The ID of the subnet. A subnet ID is not returned for an implicit association. + SubnetId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociationSetDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociationSetDetails) GoString() string { + return s.String() +} + +// SetAssociationState sets the AssociationState field's value. +func (s *AssociationSetDetails) SetAssociationState(v *AssociationStateDetails) *AssociationSetDetails { + s.AssociationState = v + return s +} + +// SetGatewayId sets the GatewayId field's value. +func (s *AssociationSetDetails) SetGatewayId(v string) *AssociationSetDetails { + s.GatewayId = &v + return s +} + +// SetMain sets the Main field's value. +func (s *AssociationSetDetails) SetMain(v bool) *AssociationSetDetails { + s.Main = &v + return s +} + +// SetRouteTableAssociationId sets the RouteTableAssociationId field's value. +func (s *AssociationSetDetails) SetRouteTableAssociationId(v string) *AssociationSetDetails { + s.RouteTableAssociationId = &v + return s +} + +// SetRouteTableId sets the RouteTableId field's value. +func (s *AssociationSetDetails) SetRouteTableId(v string) *AssociationSetDetails { + s.RouteTableId = &v + return s +} + +// SetSubnetId sets the SubnetId field's value. +func (s *AssociationSetDetails) SetSubnetId(v string) *AssociationSetDetails { + s.SubnetId = &v + return s +} + +// Describes the state of an association between a route table and a subnet +// or gateway. +type AssociationStateDetails struct { + _ struct{} `type:"structure"` + + // The state of the association. + State *string `type:"string"` + + // The status message, if applicable. + StatusMessage *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociationStateDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociationStateDetails) GoString() string { + return s.String() +} + +// SetState sets the State field's value. +func (s *AssociationStateDetails) SetState(v string) *AssociationStateDetails { + s.State = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *AssociationStateDetails) SetStatusMessage(v string) *AssociationStateDetails { + s.StatusMessage = &v + return s +} + // Information about an Availability Zone. type AvailabilityZone struct { _ struct{} `type:"structure"` @@ -14557,6 +14683,9 @@ type AwsEc2InstanceDetails struct { // Details about the metadata options for the Amazon EC2 instance. MetadataOptions *AwsEc2InstanceMetadataOptions `type:"structure"` + // Describes the type of monitoring that’s turned on for an instance. + Monitoring *AwsEc2InstanceMonitoringDetails `type:"structure"` + // The identifiers of the network interfaces for the EC2 instance. The details // for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails // object. @@ -14636,6 +14765,12 @@ func (s *AwsEc2InstanceDetails) SetMetadataOptions(v *AwsEc2InstanceMetadataOpti return s } +// SetMonitoring sets the Monitoring field's value. +func (s *AwsEc2InstanceDetails) SetMonitoring(v *AwsEc2InstanceMonitoringDetails) *AwsEc2InstanceDetails { + s.Monitoring = v + return s +} + // SetNetworkInterfaces sets the NetworkInterfaces field's value. func (s *AwsEc2InstanceDetails) SetNetworkInterfaces(v []*AwsEc2InstanceNetworkInterfacesDetails) *AwsEc2InstanceDetails { s.NetworkInterfaces = v @@ -14735,6 +14870,39 @@ func (s *AwsEc2InstanceMetadataOptions) SetInstanceMetadataTags(v string) *AwsEc return s } +// The type of monitoring that’s turned on for an Amazon EC2 instance. +type AwsEc2InstanceMonitoringDetails struct { + _ struct{} `type:"structure"` + + // Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring + // is turned on. + State *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsEc2InstanceMonitoringDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsEc2InstanceMonitoringDetails) GoString() string { + return s.String() +} + +// SetState sets the State field's value. +func (s *AwsEc2InstanceMonitoringDetails) SetState(v string) *AwsEc2InstanceMonitoringDetails { + s.State = &v + return s +} + // Identifies a network interface for the Amazon EC2 instance. type AwsEc2InstanceNetworkInterfacesDetails struct { _ struct{} `type:"structure"` @@ -17553,6 +17721,83 @@ func (s *AwsEc2NetworkInterfaceSecurityGroup) SetGroupName(v string) *AwsEc2Netw return s } +// Provides details about a route table for the specified VPC. +type AwsEc2RouteTableDetails struct { + _ struct{} `type:"structure"` + + // The associations between a route table and one or more subnets or a gateway. + AssociationSet []*AssociationSetDetails `type:"list"` + + // The ID of the Amazon Web Services account that owns the route table. + OwnerId *string `type:"string"` + + // Describes a virtual private gateway propagating route. + PropagatingVgwSet []*PropagatingVgwSetDetails `type:"list"` + + // The routes in the route table. + RouteSet []*RouteSetDetails `type:"list"` + + // The ID of the route table. + RouteTableId *string `type:"string"` + + // The ID of the virtual private cloud (VPC). + VpcId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsEc2RouteTableDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsEc2RouteTableDetails) GoString() string { + return s.String() +} + +// SetAssociationSet sets the AssociationSet field's value. +func (s *AwsEc2RouteTableDetails) SetAssociationSet(v []*AssociationSetDetails) *AwsEc2RouteTableDetails { + s.AssociationSet = v + return s +} + +// SetOwnerId sets the OwnerId field's value. +func (s *AwsEc2RouteTableDetails) SetOwnerId(v string) *AwsEc2RouteTableDetails { + s.OwnerId = &v + return s +} + +// SetPropagatingVgwSet sets the PropagatingVgwSet field's value. +func (s *AwsEc2RouteTableDetails) SetPropagatingVgwSet(v []*PropagatingVgwSetDetails) *AwsEc2RouteTableDetails { + s.PropagatingVgwSet = v + return s +} + +// SetRouteSet sets the RouteSet field's value. +func (s *AwsEc2RouteTableDetails) SetRouteSet(v []*RouteSetDetails) *AwsEc2RouteTableDetails { + s.RouteSet = v + return s +} + +// SetRouteTableId sets the RouteTableId field's value. +func (s *AwsEc2RouteTableDetails) SetRouteTableId(v string) *AwsEc2RouteTableDetails { + s.RouteTableId = &v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *AwsEc2RouteTableDetails) SetVpcId(v string) *AwsEc2RouteTableDetails { + s.VpcId = &v + return s +} + // Details about an Amazon EC2 security group. type AwsEc2SecurityGroupDetails struct { _ struct{} `type:"structure"` @@ -23508,6 +23753,12 @@ func (s *AwsEksClusterLoggingDetails) SetClusterLogging(v []*AwsEksClusterLoggin type AwsEksClusterResourcesVpcConfigDetails struct { _ struct{} `type:"structure"` + // Indicates whether the Amazon EKS public API server endpoint is turned on. + // If the Amazon EKS public API server endpoint is turned off, your cluster's + // Kubernetes API server can only receive requests that originate from within + // the cluster VPC. + EndpointPublicAccess *bool `type:"boolean"` + // The security groups that are associated with the cross-account elastic network // interfaces that are used to allow communication between your nodes and the // Amazon EKS control plane. @@ -23535,6 +23786,12 @@ func (s AwsEksClusterResourcesVpcConfigDetails) GoString() string { return s.String() } +// SetEndpointPublicAccess sets the EndpointPublicAccess field's value. +func (s *AwsEksClusterResourcesVpcConfigDetails) SetEndpointPublicAccess(v bool) *AwsEksClusterResourcesVpcConfigDetails { + s.EndpointPublicAccess = &v + return s +} + // SetSecurityGroupIds sets the SecurityGroupIds field's value. func (s *AwsEksClusterResourcesVpcConfigDetails) SetSecurityGroupIds(v []*string) *AwsEksClusterResourcesVpcConfigDetails { s.SecurityGroupIds = v @@ -33555,6 +33812,10 @@ type AwsS3BucketDetails struct { // 2020-03-22T13:22:13.933Z. CreatedAt *string `type:"string"` + // Specifies which rule Amazon S3 applies by default to every new object placed + // in the specified bucket. + ObjectLockConfiguration *AwsS3BucketObjectLockConfiguration `type:"structure"` + // The Amazon Web Services account identifier of the account that owns the S3 // bucket. OwnerAccountId *string `type:"string"` @@ -33633,6 +33894,12 @@ func (s *AwsS3BucketDetails) SetCreatedAt(v string) *AwsS3BucketDetails { return s } +// SetObjectLockConfiguration sets the ObjectLockConfiguration field's value. +func (s *AwsS3BucketDetails) SetObjectLockConfiguration(v *AwsS3BucketObjectLockConfiguration) *AwsS3BucketDetails { + s.ObjectLockConfiguration = v + return s +} + // SetOwnerAccountId sets the OwnerAccountId field's value. func (s *AwsS3BucketDetails) SetOwnerAccountId(v string) *AwsS3BucketDetails { s.OwnerAccountId = &v @@ -33911,6 +34178,136 @@ func (s *AwsS3BucketNotificationConfigurationS3KeyFilterRule) SetValue(v string) return s } +// The container element for S3 Object Lock configuration parameters. In Amazon +// S3, Object Lock can help prevent objects from being deleted or overwritten +// for a fixed amount of time or indefinitely. +type AwsS3BucketObjectLockConfiguration struct { + _ struct{} `type:"structure"` + + // Indicates whether the bucket has an Object Lock configuration enabled. + ObjectLockEnabled *string `type:"string"` + + // Specifies the Object Lock rule for the specified object. + Rule *AwsS3BucketObjectLockConfigurationRuleDetails `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfiguration) GoString() string { + return s.String() +} + +// SetObjectLockEnabled sets the ObjectLockEnabled field's value. +func (s *AwsS3BucketObjectLockConfiguration) SetObjectLockEnabled(v string) *AwsS3BucketObjectLockConfiguration { + s.ObjectLockEnabled = &v + return s +} + +// SetRule sets the Rule field's value. +func (s *AwsS3BucketObjectLockConfiguration) SetRule(v *AwsS3BucketObjectLockConfigurationRuleDetails) *AwsS3BucketObjectLockConfiguration { + s.Rule = v + return s +} + +// The default S3 Object Lock retention mode and period that you want to apply +// to new objects placed in the specified Amazon S3 bucket. +type AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails struct { + _ struct{} `type:"structure"` + + // The number of days that you want to specify for the default retention period. + Days *int64 `type:"integer"` + + // The default Object Lock retention mode you want to apply to new objects placed + // in the specified bucket. + Mode *string `type:"string"` + + // The number of years that you want to specify for the default retention period. + Years *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) GoString() string { + return s.String() +} + +// SetDays sets the Days field's value. +func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetDays(v int64) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails { + s.Days = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetMode(v string) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails { + s.Mode = &v + return s +} + +// SetYears sets the Years field's value. +func (s *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetYears(v int64) *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails { + s.Years = &v + return s +} + +// Specifies the S3 Object Lock rule for the specified object. In Amazon S3, +// Object Lock can help prevent objects from being deleted or overwritten for +// a fixed amount of time or indefinitely. +type AwsS3BucketObjectLockConfigurationRuleDetails struct { + _ struct{} `type:"structure"` + + // The default Object Lock retention mode and period that you want to apply + // to new objects placed in the specified bucket. + DefaultRetention *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfigurationRuleDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsS3BucketObjectLockConfigurationRuleDetails) GoString() string { + return s.String() +} + +// SetDefaultRetention sets the DefaultRetention field's value. +func (s *AwsS3BucketObjectLockConfigurationRuleDetails) SetDefaultRetention(v *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) *AwsS3BucketObjectLockConfigurationRuleDetails { + s.DefaultRetention = v + return s +} + // Specifies the default server-side encryption to apply to new objects in the // bucket. type AwsS3BucketServerSideEncryptionByDefault struct { @@ -35528,7 +35925,8 @@ type AwsSecurityFindingFilters struct { // The name of the process. ProcessName []*StringFilter `type:"list"` - // The parent process ID. + // The parent process ID. This field accepts positive integers between O and + // 2147483647. ProcessParentPid []*NumberFilter `type:"list"` // The path to the process executable. @@ -41203,8 +41601,7 @@ func (s *DateRange) SetValue(v int64) *DateRange { type DeclineInvitationsInput struct { _ struct{} `type:"structure"` - // The list of account IDs for the accounts from which to decline the invitations - // to Security Hub. + // The list of prospective member account IDs for which to decline an invitation. // // AccountIds is a required field AccountIds []*string `type:"list" required:"true"` @@ -41517,7 +41914,8 @@ func (s *DeleteInsightOutput) SetInsightArn(v string) *DeleteInsightOutput { type DeleteInvitationsInput struct { _ struct{} `type:"structure"` - // The list of the account IDs that sent the invitations to delete. + // The list of member account IDs that received the invitations you want to + // delete. // // AccountIds is a required field AccountIds []*string `type:"list" required:"true"` @@ -41833,7 +42231,7 @@ type DescribeHubOutput struct { // The value for this field in a member account matches the value in the administrator // account. For accounts that aren't part of an organization, the default value // of this field is SECURITY_CONTROL if you enabled Security Hub on or after - // February 9, 2023. + // February 23, 2023. ControlFindingGenerator *string `type:"string" enum:"ControlFindingGenerator"` // The ARN of the Hub resource that was retrieved. @@ -42841,7 +43239,7 @@ type EnableSecurityHubInput struct { // The value for this field in a member account matches the value in the administrator // account. For accounts that aren't part of an organization, the default value // of this field is SECURITY_CONTROL if you enabled Security Hub on or after - // February 9, 2023. + // February 23, 2023. ControlFindingGenerator *string `type:"string" enum:"ControlFindingGenerator"` // Whether to enable the security standards that Security Hub has designated @@ -47197,7 +47595,8 @@ type ProcessDetails struct { // The name of the process. Name *string `type:"string"` - // The parent process ID. + // The parent process ID. This field accepts positive integers between O and + // 2147483647. ParentPid *int64 `type:"integer"` // The path to the process executable. @@ -47391,6 +47790,38 @@ func (s *Product) SetProductSubscriptionResourcePolicy(v string) *Product { return s } +// Describes a virtual private gateway propagating route. +type PropagatingVgwSetDetails struct { + _ struct{} `type:"structure"` + + // The ID of the virtual private gateway. + GatewayId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PropagatingVgwSetDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PropagatingVgwSetDetails) GoString() string { + return s.String() +} + +// SetGatewayId sets the GatewayId field's value. +func (s *PropagatingVgwSetDetails) SetGatewayId(v string) *PropagatingVgwSetDetails { + s.GatewayId = &v + return s +} + // Identifies where the sensitive data begins and ends. type Range struct { _ struct{} `type:"structure"` @@ -47901,6 +48332,11 @@ type ResourceDetails struct { // Details for an EC2 network interface. AwsEc2NetworkInterface *AwsEc2NetworkInterfaceDetails `type:"structure"` + // Provides details about a route table. A route table contains a set of rules, + // called routes, that determine where to direct network traffic from your subnet + // or gateway. + AwsEc2RouteTable *AwsEc2RouteTableDetails `type:"structure"` + // Details for an EC2 security group. AwsEc2SecurityGroup *AwsEc2SecurityGroupDetails `type:"structure"` @@ -48264,6 +48700,12 @@ func (s *ResourceDetails) SetAwsEc2NetworkInterface(v *AwsEc2NetworkInterfaceDet return s } +// SetAwsEc2RouteTable sets the AwsEc2RouteTable field's value. +func (s *ResourceDetails) SetAwsEc2RouteTable(v *AwsEc2RouteTableDetails) *ResourceDetails { + s.AwsEc2RouteTable = v + return s +} + // SetAwsEc2SecurityGroup sets the AwsEc2SecurityGroup field's value. func (s *ResourceDetails) SetAwsEc2SecurityGroup(v *AwsEc2SecurityGroupDetails) *ResourceDetails { s.AwsEc2SecurityGroup = v @@ -48743,6 +49185,173 @@ func (s *Result) SetProcessingResult(v string) *Result { return s } +// Provides details about the routes in the route table. +type RouteSetDetails struct { + _ struct{} `type:"structure"` + + // The ID of the carrier gateway. + CarrierGatewayId *string `type:"string"` + + // The Amazon Resource Name (ARN) of the core network. + CoreNetworkArn *string `type:"string"` + + // The IPv4 CIDR block used for the destination match. + DestinationCidrBlock *string `type:"string"` + + // The IPv6 CIDR block used for the destination match. + DestinationIpv6CidrBlock *string `type:"string"` + + // The prefix of the destination Amazon Web Service. + DestinationPrefixListId *string `type:"string"` + + // The ID of the egress-only internet gateway. + EgressOnlyInternetGatewayId *string `type:"string"` + + // The ID of a gateway attached to your VPC. + GatewayId *string `type:"string"` + + // The ID of a NAT instance in your VPC. + InstanceId *string `type:"string"` + + // The ID of the Amazon Web Services account that owns the instance. + InstanceOwnerId *string `type:"string"` + + // The ID of the local gateway. + LocalGatewayId *string `type:"string"` + + // The ID of a NAT gateway. + NatGatewayId *string `type:"string"` + + // The ID of the network interface. + NetworkInterfaceId *string `type:"string"` + + // Describes how the route was created. + Origin *string `type:"string"` + + // The state of the route. + State *string `type:"string"` + + // The ID of a transit gateway. + TransitGatewayId *string `type:"string"` + + // The ID of a VPC peering connection. + VpcPeeringConnectionId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteSetDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteSetDetails) GoString() string { + return s.String() +} + +// SetCarrierGatewayId sets the CarrierGatewayId field's value. +func (s *RouteSetDetails) SetCarrierGatewayId(v string) *RouteSetDetails { + s.CarrierGatewayId = &v + return s +} + +// SetCoreNetworkArn sets the CoreNetworkArn field's value. +func (s *RouteSetDetails) SetCoreNetworkArn(v string) *RouteSetDetails { + s.CoreNetworkArn = &v + return s +} + +// SetDestinationCidrBlock sets the DestinationCidrBlock field's value. +func (s *RouteSetDetails) SetDestinationCidrBlock(v string) *RouteSetDetails { + s.DestinationCidrBlock = &v + return s +} + +// SetDestinationIpv6CidrBlock sets the DestinationIpv6CidrBlock field's value. +func (s *RouteSetDetails) SetDestinationIpv6CidrBlock(v string) *RouteSetDetails { + s.DestinationIpv6CidrBlock = &v + return s +} + +// SetDestinationPrefixListId sets the DestinationPrefixListId field's value. +func (s *RouteSetDetails) SetDestinationPrefixListId(v string) *RouteSetDetails { + s.DestinationPrefixListId = &v + return s +} + +// SetEgressOnlyInternetGatewayId sets the EgressOnlyInternetGatewayId field's value. +func (s *RouteSetDetails) SetEgressOnlyInternetGatewayId(v string) *RouteSetDetails { + s.EgressOnlyInternetGatewayId = &v + return s +} + +// SetGatewayId sets the GatewayId field's value. +func (s *RouteSetDetails) SetGatewayId(v string) *RouteSetDetails { + s.GatewayId = &v + return s +} + +// SetInstanceId sets the InstanceId field's value. +func (s *RouteSetDetails) SetInstanceId(v string) *RouteSetDetails { + s.InstanceId = &v + return s +} + +// SetInstanceOwnerId sets the InstanceOwnerId field's value. +func (s *RouteSetDetails) SetInstanceOwnerId(v string) *RouteSetDetails { + s.InstanceOwnerId = &v + return s +} + +// SetLocalGatewayId sets the LocalGatewayId field's value. +func (s *RouteSetDetails) SetLocalGatewayId(v string) *RouteSetDetails { + s.LocalGatewayId = &v + return s +} + +// SetNatGatewayId sets the NatGatewayId field's value. +func (s *RouteSetDetails) SetNatGatewayId(v string) *RouteSetDetails { + s.NatGatewayId = &v + return s +} + +// SetNetworkInterfaceId sets the NetworkInterfaceId field's value. +func (s *RouteSetDetails) SetNetworkInterfaceId(v string) *RouteSetDetails { + s.NetworkInterfaceId = &v + return s +} + +// SetOrigin sets the Origin field's value. +func (s *RouteSetDetails) SetOrigin(v string) *RouteSetDetails { + s.Origin = &v + return s +} + +// SetState sets the State field's value. +func (s *RouteSetDetails) SetState(v string) *RouteSetDetails { + s.State = &v + return s +} + +// SetTransitGatewayId sets the TransitGatewayId field's value. +func (s *RouteSetDetails) SetTransitGatewayId(v string) *RouteSetDetails { + s.TransitGatewayId = &v + return s +} + +// SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value. +func (s *RouteSetDetails) SetVpcPeeringConnectionId(v string) *RouteSetDetails { + s.VpcPeeringConnectionId = &v + return s +} + // Details about the rule group. type RuleGroupDetails struct { _ struct{} `type:"structure"` diff --git a/service/voiceid/api.go b/service/voiceid/api.go index a4b19a424ff..56939c8843e 100644 --- a/service/voiceid/api.go +++ b/service/voiceid/api.go @@ -13,6 +13,111 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" ) +const opAssociateFraudster = "AssociateFraudster" + +// AssociateFraudsterRequest generates a "aws/request.Request" representing the +// client's request for the AssociateFraudster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See AssociateFraudster for more information on using the AssociateFraudster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the AssociateFraudsterRequest method. +// req, resp := client.AssociateFraudsterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudster +func (c *VoiceID) AssociateFraudsterRequest(input *AssociateFraudsterInput) (req *request.Request, output *AssociateFraudsterOutput) { + op := &request.Operation{ + Name: opAssociateFraudster, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AssociateFraudsterInput{} + } + + output = &AssociateFraudsterOutput{} + req = c.newRequest(op, input, output) + return +} + +// AssociateFraudster API operation for Amazon Voice ID. +// +// Associates the fraudsters with the watchlist specified in the same domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation AssociateFraudster for usage and error information. +// +// Returned Error Types: +// +// - ServiceQuotaExceededException +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudster +func (c *VoiceID) AssociateFraudster(input *AssociateFraudsterInput) (*AssociateFraudsterOutput, error) { + req, out := c.AssociateFraudsterRequest(input) + return out, req.Send() +} + +// AssociateFraudsterWithContext is the same as AssociateFraudster with the addition of +// the ability to pass a context and additional request options. +// +// See AssociateFraudster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) AssociateFraudsterWithContext(ctx aws.Context, input *AssociateFraudsterInput, opts ...request.Option) (*AssociateFraudsterOutput, error) { + req, out := c.AssociateFraudsterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDomain = "CreateDomain" // CreateDomainRequest generates a "aws/request.Request" representing the @@ -57,7 +162,8 @@ func (c *VoiceID) CreateDomainRequest(input *CreateDomainInput) (req *request.Re // CreateDomain API operation for Amazon Voice ID. // // Creates a domain that contains all Amazon Connect Voice ID data, such as -// speakers, fraudsters, customer audio, and voiceprints. +// speakers, fraudsters, customer audio, and voiceprints. Every domain is created +// with a default watchlist that fraudsters can be a part of. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -119,6 +225,111 @@ func (c *VoiceID) CreateDomainWithContext(ctx aws.Context, input *CreateDomainIn return out, req.Send() } +const opCreateWatchlist = "CreateWatchlist" + +// CreateWatchlistRequest generates a "aws/request.Request" representing the +// client's request for the CreateWatchlist operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateWatchlist for more information on using the CreateWatchlist +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateWatchlistRequest method. +// req, resp := client.CreateWatchlistRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlist +func (c *VoiceID) CreateWatchlistRequest(input *CreateWatchlistInput) (req *request.Request, output *CreateWatchlistOutput) { + op := &request.Operation{ + Name: opCreateWatchlist, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateWatchlistInput{} + } + + output = &CreateWatchlistOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateWatchlist API operation for Amazon Voice ID. +// +// Creates a watchlist that fraudsters can be a part of. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation CreateWatchlist for usage and error information. +// +// Returned Error Types: +// +// - ServiceQuotaExceededException +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlist +func (c *VoiceID) CreateWatchlist(input *CreateWatchlistInput) (*CreateWatchlistOutput, error) { + req, out := c.CreateWatchlistRequest(input) + return out, req.Send() +} + +// CreateWatchlistWithContext is the same as CreateWatchlist with the addition of +// the ability to pass a context and additional request options. +// +// See CreateWatchlist for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) CreateWatchlistWithContext(ctx aws.Context, input *CreateWatchlistInput, opts ...request.Option) (*CreateWatchlistOutput, error) { + req, out := c.CreateWatchlistRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDomain = "DeleteDomain" // DeleteDomainRequest generates a "aws/request.Request" representing the @@ -264,7 +475,8 @@ func (c *VoiceID) DeleteFraudsterRequest(input *DeleteFraudsterInput) (req *requ // DeleteFraudster API operation for Amazon Voice ID. // -// Deletes the specified fraudster from Voice ID. +// Deletes the specified fraudster from Voice ID. This action disassociates +// the fraudster from any watchlists it is a part of. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -422,6 +634,110 @@ func (c *VoiceID) DeleteSpeakerWithContext(ctx aws.Context, input *DeleteSpeaker return out, req.Send() } +const opDeleteWatchlist = "DeleteWatchlist" + +// DeleteWatchlistRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWatchlist operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteWatchlist for more information on using the DeleteWatchlist +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteWatchlistRequest method. +// req, resp := client.DeleteWatchlistRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlist +func (c *VoiceID) DeleteWatchlistRequest(input *DeleteWatchlistInput) (req *request.Request, output *DeleteWatchlistOutput) { + op := &request.Operation{ + Name: opDeleteWatchlist, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteWatchlistInput{} + } + + output = &DeleteWatchlistOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteWatchlist API operation for Amazon Voice ID. +// +// Deletes the specified watchlist from Voice ID. This API throws an exception +// when there are fraudsters in the watchlist that you are trying to delete. +// You must delete the fraudsters, and then delete the watchlist. Every domain +// has a default watchlist which cannot be deleted. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DeleteWatchlist for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlist +func (c *VoiceID) DeleteWatchlist(input *DeleteWatchlistInput) (*DeleteWatchlistOutput, error) { + req, out := c.DeleteWatchlistRequest(input) + return out, req.Send() +} + +// DeleteWatchlistWithContext is the same as DeleteWatchlist with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteWatchlist for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DeleteWatchlistWithContext(ctx aws.Context, input *DeleteWatchlistInput, opts ...request.Option) (*DeleteWatchlistOutput, error) { + req, out := c.DeleteWatchlistRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDomain = "DescribeDomain" // DescribeDomainRequest generates a "aws/request.Request" representing the @@ -902,32 +1218,231 @@ func (c *VoiceID) DescribeSpeakerEnrollmentJobWithContext(ctx aws.Context, input return out, req.Send() } -const opEvaluateSession = "EvaluateSession" +const opDescribeWatchlist = "DescribeWatchlist" -// EvaluateSessionRequest generates a "aws/request.Request" representing the -// client's request for the EvaluateSession operation. The "output" return +// DescribeWatchlistRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWatchlist operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See EvaluateSession for more information on using the EvaluateSession +// See DescribeWatchlist for more information on using the DescribeWatchlist // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the EvaluateSessionRequest method. -// req, resp := client.EvaluateSessionRequest(params) +// // Example sending a request using the DescribeWatchlistRequest method. +// req, resp := client.DescribeWatchlistRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession -func (c *VoiceID) EvaluateSessionRequest(input *EvaluateSessionInput) (req *request.Request, output *EvaluateSessionOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist +func (c *VoiceID) DescribeWatchlistRequest(input *DescribeWatchlistInput) (req *request.Request, output *DescribeWatchlistOutput) { + op := &request.Operation{ + Name: opDescribeWatchlist, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeWatchlistInput{} + } + + output = &DescribeWatchlistOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeWatchlist API operation for Amazon Voice ID. +// +// Describes the specified watchlist. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeWatchlist for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist +func (c *VoiceID) DescribeWatchlist(input *DescribeWatchlistInput) (*DescribeWatchlistOutput, error) { + req, out := c.DescribeWatchlistRequest(input) + return out, req.Send() +} + +// DescribeWatchlistWithContext is the same as DescribeWatchlist with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeWatchlist for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeWatchlistWithContext(ctx aws.Context, input *DescribeWatchlistInput, opts ...request.Option) (*DescribeWatchlistOutput, error) { + req, out := c.DescribeWatchlistRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDisassociateFraudster = "DisassociateFraudster" + +// DisassociateFraudsterRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateFraudster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DisassociateFraudster for more information on using the DisassociateFraudster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DisassociateFraudsterRequest method. +// req, resp := client.DisassociateFraudsterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudster +func (c *VoiceID) DisassociateFraudsterRequest(input *DisassociateFraudsterInput) (req *request.Request, output *DisassociateFraudsterOutput) { + op := &request.Operation{ + Name: opDisassociateFraudster, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DisassociateFraudsterInput{} + } + + output = &DisassociateFraudsterOutput{} + req = c.newRequest(op, input, output) + return +} + +// DisassociateFraudster API operation for Amazon Voice ID. +// +// Disassociates the fraudsters from the watchlist specified. Voice ID always +// expects a fraudster to be a part of at least one watchlist. If you try to +// disassociate a fraudster from its only watchlist, a ValidationException is +// thrown. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DisassociateFraudster for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudster +func (c *VoiceID) DisassociateFraudster(input *DisassociateFraudsterInput) (*DisassociateFraudsterOutput, error) { + req, out := c.DisassociateFraudsterRequest(input) + return out, req.Send() +} + +// DisassociateFraudsterWithContext is the same as DisassociateFraudster with the addition of +// the ability to pass a context and additional request options. +// +// See DisassociateFraudster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DisassociateFraudsterWithContext(ctx aws.Context, input *DisassociateFraudsterInput, opts ...request.Option) (*DisassociateFraudsterOutput, error) { + req, out := c.DisassociateFraudsterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opEvaluateSession = "EvaluateSession" + +// EvaluateSessionRequest generates a "aws/request.Request" representing the +// client's request for the EvaluateSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See EvaluateSession for more information on using the EvaluateSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the EvaluateSessionRequest method. +// req, resp := client.EvaluateSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession +func (c *VoiceID) EvaluateSessionRequest(input *EvaluateSessionInput) (req *request.Request, output *EvaluateSessionOutput) { op := &request.Operation{ Name: opEvaluateSession, HTTPMethod: "POST", @@ -1307,34 +1822,34 @@ func (c *VoiceID) ListFraudsterRegistrationJobsPagesWithContext(ctx aws.Context, return p.Err() } -const opListSpeakerEnrollmentJobs = "ListSpeakerEnrollmentJobs" +const opListFraudsters = "ListFraudsters" -// ListSpeakerEnrollmentJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListSpeakerEnrollmentJobs operation. The "output" return +// ListFraudstersRequest generates a "aws/request.Request" representing the +// client's request for the ListFraudsters operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListSpeakerEnrollmentJobs for more information on using the ListSpeakerEnrollmentJobs +// See ListFraudsters for more information on using the ListFraudsters // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListSpeakerEnrollmentJobsRequest method. -// req, resp := client.ListSpeakerEnrollmentJobsRequest(params) +// // Example sending a request using the ListFraudstersRequest method. +// req, resp := client.ListFraudstersRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs -func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJobsInput) (req *request.Request, output *ListSpeakerEnrollmentJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsters +func (c *VoiceID) ListFraudstersRequest(input *ListFraudstersInput) (req *request.Request, output *ListFraudstersOutput) { op := &request.Operation{ - Name: opListSpeakerEnrollmentJobs, + Name: opListFraudsters, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -1346,26 +1861,24 @@ func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJ } if input == nil { - input = &ListSpeakerEnrollmentJobsInput{} + input = &ListFraudstersInput{} } - output = &ListSpeakerEnrollmentJobsOutput{} + output = &ListFraudstersOutput{} req = c.newRequest(op, input, output) return } -// ListSpeakerEnrollmentJobs API operation for Amazon Voice ID. +// ListFraudsters API operation for Amazon Voice ID. // -// Lists all the speaker enrollment jobs in the domain with the specified JobStatus. -// If JobStatus is not provided, this lists all jobs with all possible speaker -// enrollment job statuses. +// Lists all fraudsters in a specified watchlist or domain. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Voice ID's -// API operation ListSpeakerEnrollmentJobs for usage and error information. +// API operation ListFraudsters for usage and error information. // // Returned Error Types: // @@ -1389,64 +1902,64 @@ func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJ // You do not have sufficient permissions to perform this action. Check the // error message and try again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs -func (c *VoiceID) ListSpeakerEnrollmentJobs(input *ListSpeakerEnrollmentJobsInput) (*ListSpeakerEnrollmentJobsOutput, error) { - req, out := c.ListSpeakerEnrollmentJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsters +func (c *VoiceID) ListFraudsters(input *ListFraudstersInput) (*ListFraudstersOutput, error) { + req, out := c.ListFraudstersRequest(input) return out, req.Send() } -// ListSpeakerEnrollmentJobsWithContext is the same as ListSpeakerEnrollmentJobs with the addition of +// ListFraudstersWithContext is the same as ListFraudsters with the addition of // the ability to pass a context and additional request options. // -// See ListSpeakerEnrollmentJobs for details on how to use this API operation. +// See ListFraudsters for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *VoiceID) ListSpeakerEnrollmentJobsWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, opts ...request.Option) (*ListSpeakerEnrollmentJobsOutput, error) { - req, out := c.ListSpeakerEnrollmentJobsRequest(input) +func (c *VoiceID) ListFraudstersWithContext(ctx aws.Context, input *ListFraudstersInput, opts ...request.Option) (*ListFraudstersOutput, error) { + req, out := c.ListFraudstersRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSpeakerEnrollmentJobsPages iterates over the pages of a ListSpeakerEnrollmentJobs operation, +// ListFraudstersPages iterates over the pages of a ListFraudsters operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListSpeakerEnrollmentJobs method for more information on how to use this operation. +// See ListFraudsters method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListSpeakerEnrollmentJobs operation. +// // Example iterating over at most 3 pages of a ListFraudsters operation. // pageNum := 0 -// err := client.ListSpeakerEnrollmentJobsPages(params, -// func(page *voiceid.ListSpeakerEnrollmentJobsOutput, lastPage bool) bool { +// err := client.ListFraudstersPages(params, +// func(page *voiceid.ListFraudstersOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *VoiceID) ListSpeakerEnrollmentJobsPages(input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool) error { - return c.ListSpeakerEnrollmentJobsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *VoiceID) ListFraudstersPages(input *ListFraudstersInput, fn func(*ListFraudstersOutput, bool) bool) error { + return c.ListFraudstersPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListSpeakerEnrollmentJobsPagesWithContext same as ListSpeakerEnrollmentJobsPages except +// ListFraudstersPagesWithContext same as ListFraudstersPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool, opts ...request.Option) error { +func (c *VoiceID) ListFraudstersPagesWithContext(ctx aws.Context, input *ListFraudstersInput, fn func(*ListFraudstersOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListSpeakerEnrollmentJobsInput + var inCpy *ListFraudstersInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListSpeakerEnrollmentJobsRequest(inCpy) + req, _ := c.ListFraudstersRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -1454,7 +1967,7 @@ func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, inp } for p.Next() { - if !fn(p.Page().(*ListSpeakerEnrollmentJobsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListFraudstersOutput), !p.HasNextPage()) { break } } @@ -1462,34 +1975,34 @@ func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, inp return p.Err() } -const opListSpeakers = "ListSpeakers" +const opListSpeakerEnrollmentJobs = "ListSpeakerEnrollmentJobs" -// ListSpeakersRequest generates a "aws/request.Request" representing the -// client's request for the ListSpeakers operation. The "output" return +// ListSpeakerEnrollmentJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListSpeakerEnrollmentJobs operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListSpeakers for more information on using the ListSpeakers +// See ListSpeakerEnrollmentJobs for more information on using the ListSpeakerEnrollmentJobs // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListSpeakersRequest method. -// req, resp := client.ListSpeakersRequest(params) +// // Example sending a request using the ListSpeakerEnrollmentJobsRequest method. +// req, resp := client.ListSpeakerEnrollmentJobsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers -func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Request, output *ListSpeakersOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs +func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJobsInput) (req *request.Request, output *ListSpeakerEnrollmentJobsOutput) { op := &request.Operation{ - Name: opListSpeakers, + Name: opListSpeakerEnrollmentJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -1501,24 +2014,26 @@ func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Re } if input == nil { - input = &ListSpeakersInput{} + input = &ListSpeakerEnrollmentJobsInput{} } - output = &ListSpeakersOutput{} + output = &ListSpeakerEnrollmentJobsOutput{} req = c.newRequest(op, input, output) return } -// ListSpeakers API operation for Amazon Voice ID. +// ListSpeakerEnrollmentJobs API operation for Amazon Voice ID. // -// Lists all speakers in a specified domain. +// Lists all the speaker enrollment jobs in the domain with the specified JobStatus. +// If JobStatus is not provided, this lists all jobs with all possible speaker +// enrollment job statuses. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Voice ID's -// API operation ListSpeakers for usage and error information. +// API operation ListSpeakerEnrollmentJobs for usage and error information. // // Returned Error Types: // @@ -1542,49 +2057,202 @@ func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Re // You do not have sufficient permissions to perform this action. Check the // error message and try again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers -func (c *VoiceID) ListSpeakers(input *ListSpeakersInput) (*ListSpeakersOutput, error) { - req, out := c.ListSpeakersRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs +func (c *VoiceID) ListSpeakerEnrollmentJobs(input *ListSpeakerEnrollmentJobsInput) (*ListSpeakerEnrollmentJobsOutput, error) { + req, out := c.ListSpeakerEnrollmentJobsRequest(input) return out, req.Send() } -// ListSpeakersWithContext is the same as ListSpeakers with the addition of +// ListSpeakerEnrollmentJobsWithContext is the same as ListSpeakerEnrollmentJobs with the addition of // the ability to pass a context and additional request options. // -// See ListSpeakers for details on how to use this API operation. +// See ListSpeakerEnrollmentJobs for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *VoiceID) ListSpeakersWithContext(ctx aws.Context, input *ListSpeakersInput, opts ...request.Option) (*ListSpeakersOutput, error) { - req, out := c.ListSpeakersRequest(input) +func (c *VoiceID) ListSpeakerEnrollmentJobsWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, opts ...request.Option) (*ListSpeakerEnrollmentJobsOutput, error) { + req, out := c.ListSpeakerEnrollmentJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSpeakersPages iterates over the pages of a ListSpeakers operation, +// ListSpeakerEnrollmentJobsPages iterates over the pages of a ListSpeakerEnrollmentJobs operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListSpeakers method for more information on how to use this operation. +// See ListSpeakerEnrollmentJobs method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListSpeakers operation. +// // Example iterating over at most 3 pages of a ListSpeakerEnrollmentJobs operation. // pageNum := 0 -// err := client.ListSpeakersPages(params, -// func(page *voiceid.ListSpeakersOutput, lastPage bool) bool { +// err := client.ListSpeakerEnrollmentJobsPages(params, +// func(page *voiceid.ListSpeakerEnrollmentJobsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *VoiceID) ListSpeakersPages(input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool) error { - return c.ListSpeakersPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *VoiceID) ListSpeakerEnrollmentJobsPages(input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool) error { + return c.ListSpeakerEnrollmentJobsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListSpeakersPagesWithContext same as ListSpeakersPages except +// ListSpeakerEnrollmentJobsPagesWithContext same as ListSpeakerEnrollmentJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSpeakerEnrollmentJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSpeakerEnrollmentJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSpeakerEnrollmentJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSpeakers = "ListSpeakers" + +// ListSpeakersRequest generates a "aws/request.Request" representing the +// client's request for the ListSpeakers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSpeakers for more information on using the ListSpeakers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListSpeakersRequest method. +// req, resp := client.ListSpeakersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers +func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Request, output *ListSpeakersOutput) { + op := &request.Operation{ + Name: opListSpeakers, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSpeakersInput{} + } + + output = &ListSpeakersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSpeakers API operation for Amazon Voice ID. +// +// Lists all speakers in a specified domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListSpeakers for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers +func (c *VoiceID) ListSpeakers(input *ListSpeakersInput) (*ListSpeakersOutput, error) { + req, out := c.ListSpeakersRequest(input) + return out, req.Send() +} + +// ListSpeakersWithContext is the same as ListSpeakers with the addition of +// the ability to pass a context and additional request options. +// +// See ListSpeakers for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakersWithContext(ctx aws.Context, input *ListSpeakersInput, opts ...request.Option) (*ListSpeakersOutput, error) { + req, out := c.ListSpeakersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSpeakersPages iterates over the pages of a ListSpeakers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSpeakers method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListSpeakers operation. +// pageNum := 0 +// err := client.ListSpeakersPages(params, +// func(page *voiceid.ListSpeakersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *VoiceID) ListSpeakersPages(input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool) error { + return c.ListSpeakersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSpeakersPagesWithContext same as ListSpeakersPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If @@ -1711,6 +2379,159 @@ func (c *VoiceID) ListTagsForResourceWithContext(ctx aws.Context, input *ListTag return out, req.Send() } +const opListWatchlists = "ListWatchlists" + +// ListWatchlistsRequest generates a "aws/request.Request" representing the +// client's request for the ListWatchlists operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListWatchlists for more information on using the ListWatchlists +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListWatchlistsRequest method. +// req, resp := client.ListWatchlistsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlists +func (c *VoiceID) ListWatchlistsRequest(input *ListWatchlistsInput) (req *request.Request, output *ListWatchlistsOutput) { + op := &request.Operation{ + Name: opListWatchlists, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWatchlistsInput{} + } + + output = &ListWatchlistsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWatchlists API operation for Amazon Voice ID. +// +// Lists all watchlists in a specified domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListWatchlists for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlists +func (c *VoiceID) ListWatchlists(input *ListWatchlistsInput) (*ListWatchlistsOutput, error) { + req, out := c.ListWatchlistsRequest(input) + return out, req.Send() +} + +// ListWatchlistsWithContext is the same as ListWatchlists with the addition of +// the ability to pass a context and additional request options. +// +// See ListWatchlists for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListWatchlistsWithContext(ctx aws.Context, input *ListWatchlistsInput, opts ...request.Option) (*ListWatchlistsOutput, error) { + req, out := c.ListWatchlistsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWatchlistsPages iterates over the pages of a ListWatchlists operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWatchlists method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListWatchlists operation. +// pageNum := 0 +// err := client.ListWatchlistsPages(params, +// func(page *voiceid.ListWatchlistsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *VoiceID) ListWatchlistsPages(input *ListWatchlistsInput, fn func(*ListWatchlistsOutput, bool) bool) error { + return c.ListWatchlistsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWatchlistsPagesWithContext same as ListWatchlistsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListWatchlistsPagesWithContext(ctx aws.Context, input *ListWatchlistsInput, fn func(*ListWatchlistsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWatchlistsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWatchlistsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWatchlistsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opOptOutSpeaker = "OptOutSpeaker" // OptOutSpeakerRequest generates a "aws/request.Request" representing the @@ -2165,25 +2986,127 @@ func (c *VoiceID) UntagResourceRequest(input *UntagResourceInput) (req *request. } if input == nil { - input = &UntagResourceInput{} + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon Voice ID. +// +// Removes specified tags from a specified Amazon Connect Voice ID resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// - ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// - ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// - InternalServerException +// The request failed due to an unknown error on the server side. +// +// - ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource +func (c *VoiceID) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateDomain = "UpdateDomain" + +// UpdateDomainRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateDomain for more information on using the UpdateDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateDomainRequest method. +// req, resp := client.UpdateDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain +func (c *VoiceID) UpdateDomainRequest(input *UpdateDomainInput) (req *request.Request, output *UpdateDomainOutput) { + op := &request.Operation{ + Name: opUpdateDomain, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateDomainInput{} } - output = &UntagResourceOutput{} + output = &UpdateDomainOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for Amazon Voice ID. +// UpdateDomain API operation for Amazon Voice ID. // -// Removes specified tags from a specified Amazon Connect Voice ID resource. +// Updates the specified domain. This API has clobber behavior, and clears and +// replaces all attributes. If an optional field, such as 'Description' is not +// provided, it is removed from the domain. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Voice ID's -// API operation UntagResource for usage and error information. +// API operation UpdateDomain for usage and error information. // // Returned Error Types: // @@ -2211,81 +3134,80 @@ func (c *VoiceID) UntagResourceRequest(input *UntagResourceInput) (req *request. // You do not have sufficient permissions to perform this action. Check the // error message and try again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource -func (c *VoiceID) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain +func (c *VoiceID) UpdateDomain(input *UpdateDomainInput) (*UpdateDomainOutput, error) { + req, out := c.UpdateDomainRequest(input) return out, req.Send() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// UpdateDomainWithContext is the same as UpdateDomain with the addition of // the ability to pass a context and additional request options. // -// See UntagResource for details on how to use this API operation. +// See UpdateDomain for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *VoiceID) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *VoiceID) UpdateDomainWithContext(ctx aws.Context, input *UpdateDomainInput, opts ...request.Option) (*UpdateDomainOutput, error) { + req, out := c.UpdateDomainRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateDomain = "UpdateDomain" +const opUpdateWatchlist = "UpdateWatchlist" -// UpdateDomainRequest generates a "aws/request.Request" representing the -// client's request for the UpdateDomain operation. The "output" return +// UpdateWatchlistRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWatchlist operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateDomain for more information on using the UpdateDomain +// See UpdateWatchlist for more information on using the UpdateWatchlist // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the UpdateDomainRequest method. -// req, resp := client.UpdateDomainRequest(params) +// // Example sending a request using the UpdateWatchlistRequest method. +// req, resp := client.UpdateWatchlistRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain -func (c *VoiceID) UpdateDomainRequest(input *UpdateDomainInput) (req *request.Request, output *UpdateDomainOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlist +func (c *VoiceID) UpdateWatchlistRequest(input *UpdateWatchlistInput) (req *request.Request, output *UpdateWatchlistOutput) { op := &request.Operation{ - Name: opUpdateDomain, + Name: opUpdateWatchlist, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateDomainInput{} + input = &UpdateWatchlistInput{} } - output = &UpdateDomainOutput{} + output = &UpdateWatchlistOutput{} req = c.newRequest(op, input, output) return } -// UpdateDomain API operation for Amazon Voice ID. +// UpdateWatchlist API operation for Amazon Voice ID. // -// Updates the specified domain. This API has clobber behavior, and clears and -// replaces all attributes. If an optional field, such as 'Description' is not -// provided, it is removed from the domain. +// Updates the specified watchlist. Every domain has a default watchlist which +// cannot be updated. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Voice ID's -// API operation UpdateDomain for usage and error information. +// API operation UpdateWatchlist for usage and error information. // // Returned Error Types: // @@ -2313,23 +3235,23 @@ func (c *VoiceID) UpdateDomainRequest(input *UpdateDomainInput) (req *request.Re // You do not have sufficient permissions to perform this action. Check the // error message and try again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain -func (c *VoiceID) UpdateDomain(input *UpdateDomainInput) (*UpdateDomainOutput, error) { - req, out := c.UpdateDomainRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlist +func (c *VoiceID) UpdateWatchlist(input *UpdateWatchlistInput) (*UpdateWatchlistOutput, error) { + req, out := c.UpdateWatchlistRequest(input) return out, req.Send() } -// UpdateDomainWithContext is the same as UpdateDomain with the addition of +// UpdateWatchlistWithContext is the same as UpdateWatchlist with the addition of // the ability to pass a context and additional request options. // -// See UpdateDomain for details on how to use this API operation. +// See UpdateWatchlist for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *VoiceID) UpdateDomainWithContext(ctx aws.Context, input *UpdateDomainInput, opts ...request.Option) (*UpdateDomainOutput, error) { - req, out := c.UpdateDomainRequest(input) +func (c *VoiceID) UpdateWatchlistWithContext(ctx aws.Context, input *UpdateWatchlistInput, opts ...request.Option) (*UpdateWatchlistOutput, error) { + req, out := c.UpdateWatchlistRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -2400,6 +3322,124 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +type AssociateFraudsterInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain that contains the fraudster. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the fraudster to be associated with the watchlist. + // + // FraudsterId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AssociateFraudsterInput's + // String and GoString methods. + // + // FraudsterId is a required field + FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"` + + // The identifier of the watchlist you want to associate with the fraudster. + // + // WatchlistId is a required field + WatchlistId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociateFraudsterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociateFraudsterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateFraudsterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateFraudsterInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.FraudsterId == nil { + invalidParams.Add(request.NewErrParamRequired("FraudsterId")) + } + if s.FraudsterId != nil && len(*s.FraudsterId) < 25 { + invalidParams.Add(request.NewErrParamMinLen("FraudsterId", 25)) + } + if s.WatchlistId == nil { + invalidParams.Add(request.NewErrParamRequired("WatchlistId")) + } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *AssociateFraudsterInput) SetDomainId(v string) *AssociateFraudsterInput { + s.DomainId = &v + return s +} + +// SetFraudsterId sets the FraudsterId field's value. +func (s *AssociateFraudsterInput) SetFraudsterId(v string) *AssociateFraudsterInput { + s.FraudsterId = &v + return s +} + +// SetWatchlistId sets the WatchlistId field's value. +func (s *AssociateFraudsterInput) SetWatchlistId(v string) *AssociateFraudsterInput { + s.WatchlistId = &v + return s +} + +type AssociateFraudsterOutput struct { + _ struct{} `type:"structure"` + + // Contains all the information about a fraudster. + Fraudster *Fraudster `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociateFraudsterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AssociateFraudsterOutput) GoString() string { + return s.String() +} + +// SetFraudster sets the Fraudster field's value. +func (s *AssociateFraudsterOutput) SetFraudster(v *Fraudster) *AssociateFraudsterOutput { + s.Fraudster = v + return s +} + // The configuration used to authenticate a speaker during a session. type AuthenticationConfiguration struct { _ struct{} `type:"structure"` @@ -2439,12 +3479,10 @@ func (s *AuthenticationConfiguration) SetAcceptanceThreshold(v int64) *Authentic type AuthenticationResult struct { _ struct{} `type:"structure"` - // A timestamp indicating when audio aggregation ended for this authentication - // result. + // A timestamp of when audio aggregation ended for this authentication result. AudioAggregationEndedAt *time.Time `type:"timestamp"` - // A timestamp indicating when audio aggregation started for this authentication - // result. + // A timestamp of when audio aggregation started for this authentication result. AudioAggregationStartedAt *time.Time `type:"timestamp"` // The unique identifier for this authentication result. Because there can be @@ -2633,11 +3671,13 @@ func (s *ConflictException) RequestID() string { type CreateDomainInput struct { _ struct{} `type:"structure"` - // The idempotency token for creating a new domain. If not provided, Amazon - // Web Services SDK populates this field. + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. If not provided, the Amazon Web Services SDK populates this + // field. For more information about idempotency, see Making retries safe with + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` - // A brief description of the domain. + // A brief description of this domain. // // Description is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateDomainInput's @@ -2753,11 +3793,143 @@ func (s *CreateDomainInput) SetTags(v []*Tag) *CreateDomainInput { return s } -type CreateDomainOutput struct { +type CreateDomainOutput struct { + _ struct{} `type:"structure"` + + // Information about the newly created domain. + Domain *Domain `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainOutput) GoString() string { + return s.String() +} + +// SetDomain sets the Domain field's value. +func (s *CreateDomainOutput) SetDomain(v *Domain) *CreateDomainOutput { + s.Domain = v + return s +} + +type CreateWatchlistInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. If not provided, the Amazon Web Services SDK populates this + // field. For more information about idempotency, see Making retries safe with + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // A brief description of this watchlist. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateWatchlistInput's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain that contains the watchlist. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The name of the watchlist. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateWatchlistInput's + // String and GoString methods. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWatchlistInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWatchlistInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateWatchlistInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWatchlistInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateWatchlistInput) SetClientToken(v string) *CreateWatchlistInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateWatchlistInput) SetDescription(v string) *CreateWatchlistInput { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *CreateWatchlistInput) SetDomainId(v string) *CreateWatchlistInput { + s.DomainId = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateWatchlistInput) SetName(v string) *CreateWatchlistInput { + s.Name = &v + return s +} + +type CreateWatchlistOutput struct { _ struct{} `type:"structure"` - // Information about the newly created domain. - Domain *Domain `type:"structure"` + // Information about the newly created watchlist. + Watchlist *Watchlist `type:"structure"` } // String returns the string representation. @@ -2765,7 +3937,7 @@ type CreateDomainOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDomainOutput) String() string { +func (s CreateWatchlistOutput) String() string { return awsutil.Prettify(s) } @@ -2774,13 +3946,13 @@ func (s CreateDomainOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDomainOutput) GoString() string { +func (s CreateWatchlistOutput) GoString() string { return s.String() } -// SetDomain sets the Domain field's value. -func (s *CreateDomainOutput) SetDomain(v *Domain) *CreateDomainOutput { - s.Domain = v +// SetWatchlist sets the Watchlist field's value. +func (s *CreateWatchlistOutput) SetWatchlist(v *Watchlist) *CreateWatchlistOutput { + s.Watchlist = v return s } @@ -2858,7 +4030,7 @@ func (s DeleteDomainOutput) GoString() string { type DeleteFraudsterInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the fraudster. + // The identifier of the domain that contains the fraudster. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -2950,7 +4122,7 @@ func (s DeleteFraudsterOutput) GoString() string { type DeleteSpeakerInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the speaker. + // The identifier of the domain that contains the speaker. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -3039,10 +4211,98 @@ func (s DeleteSpeakerOutput) GoString() string { return s.String() } +type DeleteWatchlistInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain that contains the watchlist. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the watchlist to be deleted. + // + // WatchlistId is a required field + WatchlistId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWatchlistInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWatchlistInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteWatchlistInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWatchlistInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.WatchlistId == nil { + invalidParams.Add(request.NewErrParamRequired("WatchlistId")) + } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DeleteWatchlistInput) SetDomainId(v string) *DeleteWatchlistInput { + s.DomainId = &v + return s +} + +// SetWatchlistId sets the WatchlistId field's value. +func (s *DeleteWatchlistInput) SetWatchlistId(v string) *DeleteWatchlistInput { + s.WatchlistId = &v + return s +} + +type DeleteWatchlistOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWatchlistOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteWatchlistOutput) GoString() string { + return s.String() +} + type DescribeDomainInput struct { _ struct{} `type:"structure"` - // The identifier of the domain you are describing. + // The identifier of the domain that you are describing. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -3122,7 +4382,7 @@ func (s *DescribeDomainOutput) SetDomain(v *Domain) *DescribeDomainOutput { type DescribeFraudsterInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the fraudster. + // The identifier of the domain that contains the fraudster. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -3223,12 +4483,12 @@ func (s *DescribeFraudsterOutput) SetFraudster(v *Fraudster) *DescribeFraudsterO type DescribeFraudsterRegistrationJobInput struct { _ struct{} `type:"structure"` - // The identifier for the domain containing the fraudster registration job. + // The identifier of the domain that contains the fraudster registration job. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` - // The identifier for the fraudster registration job you are describing. + // The identifier of the fraudster registration job you are describing. // // JobId is a required field JobId *string `min:"22" type:"string" required:"true"` @@ -3320,7 +4580,7 @@ func (s *DescribeFraudsterRegistrationJobOutput) SetJob(v *FraudsterRegistration type DescribeSpeakerEnrollmentJobInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the speaker enrollment job. + // The identifier of the domain that contains the speaker enrollment job. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -3404,32 +4664,235 @@ func (s DescribeSpeakerEnrollmentJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeSpeakerEnrollmentJobOutput) GoString() string { +func (s DescribeSpeakerEnrollmentJobOutput) GoString() string { + return s.String() +} + +// SetJob sets the Job field's value. +func (s *DescribeSpeakerEnrollmentJobOutput) SetJob(v *SpeakerEnrollmentJob) *DescribeSpeakerEnrollmentJobOutput { + s.Job = v + return s +} + +type DescribeSpeakerInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain that contains the speaker. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the speaker you are describing. + // + // SpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribeSpeakerInput's + // String and GoString methods. + // + // SpeakerId is a required field + SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeSpeakerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSpeakerInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.SpeakerId == nil { + invalidParams.Add(request.NewErrParamRequired("SpeakerId")) + } + if s.SpeakerId != nil && len(*s.SpeakerId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SpeakerId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeSpeakerInput) SetDomainId(v string) *DescribeSpeakerInput { + s.DomainId = &v + return s +} + +// SetSpeakerId sets the SpeakerId field's value. +func (s *DescribeSpeakerInput) SetSpeakerId(v string) *DescribeSpeakerInput { + s.SpeakerId = &v + return s +} + +type DescribeSpeakerOutput struct { + _ struct{} `type:"structure"` + + // Information about the specified speaker. + Speaker *Speaker `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerOutput) GoString() string { + return s.String() +} + +// SetSpeaker sets the Speaker field's value. +func (s *DescribeSpeakerOutput) SetSpeaker(v *Speaker) *DescribeSpeakerOutput { + s.Speaker = v + return s +} + +type DescribeWatchlistInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain that contains the watchlist. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the watchlist that you are describing. + // + // WatchlistId is a required field + WatchlistId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWatchlistInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWatchlistInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeWatchlistInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWatchlistInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.WatchlistId == nil { + invalidParams.Add(request.NewErrParamRequired("WatchlistId")) + } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeWatchlistInput) SetDomainId(v string) *DescribeWatchlistInput { + s.DomainId = &v + return s +} + +// SetWatchlistId sets the WatchlistId field's value. +func (s *DescribeWatchlistInput) SetWatchlistId(v string) *DescribeWatchlistInput { + s.WatchlistId = &v + return s +} + +type DescribeWatchlistOutput struct { + _ struct{} `type:"structure"` + + // Information about the specified watchlist. + Watchlist *Watchlist `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWatchlistOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeWatchlistOutput) GoString() string { return s.String() } -// SetJob sets the Job field's value. -func (s *DescribeSpeakerEnrollmentJobOutput) SetJob(v *SpeakerEnrollmentJob) *DescribeSpeakerEnrollmentJobOutput { - s.Job = v +// SetWatchlist sets the Watchlist field's value. +func (s *DescribeWatchlistOutput) SetWatchlist(v *Watchlist) *DescribeWatchlistOutput { + s.Watchlist = v return s } -type DescribeSpeakerInput struct { +type DisassociateFraudsterInput struct { _ struct{} `type:"structure"` - // The identifier of the domain that contains the speaker. + // The identifier of the domain that contains the fraudster. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` - // The identifier of the speaker you are describing. + // The identifier of the fraudster to be disassociated from the watchlist. // - // SpeakerId is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by DescribeSpeakerInput's + // FraudsterId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DisassociateFraudsterInput's // String and GoString methods. // - // SpeakerId is a required field - SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"` + // FraudsterId is a required field + FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"` + + // The identifier of the watchlist that you want to disassociate from the fraudster. + // + // WatchlistId is a required field + WatchlistId *string `min:"22" type:"string" required:"true"` } // String returns the string representation. @@ -3437,7 +4900,7 @@ type DescribeSpeakerInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeSpeakerInput) String() string { +func (s DisassociateFraudsterInput) String() string { return awsutil.Prettify(s) } @@ -3446,24 +4909,30 @@ func (s DescribeSpeakerInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeSpeakerInput) GoString() string { +func (s DisassociateFraudsterInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeSpeakerInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeSpeakerInput"} +func (s *DisassociateFraudsterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociateFraudsterInput"} if s.DomainId == nil { invalidParams.Add(request.NewErrParamRequired("DomainId")) } if s.DomainId != nil && len(*s.DomainId) < 22 { invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) } - if s.SpeakerId == nil { - invalidParams.Add(request.NewErrParamRequired("SpeakerId")) + if s.FraudsterId == nil { + invalidParams.Add(request.NewErrParamRequired("FraudsterId")) } - if s.SpeakerId != nil && len(*s.SpeakerId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SpeakerId", 1)) + if s.FraudsterId != nil && len(*s.FraudsterId) < 25 { + invalidParams.Add(request.NewErrParamMinLen("FraudsterId", 25)) + } + if s.WatchlistId == nil { + invalidParams.Add(request.NewErrParamRequired("WatchlistId")) + } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) } if invalidParams.Len() > 0 { @@ -3473,22 +4942,28 @@ func (s *DescribeSpeakerInput) Validate() error { } // SetDomainId sets the DomainId field's value. -func (s *DescribeSpeakerInput) SetDomainId(v string) *DescribeSpeakerInput { +func (s *DisassociateFraudsterInput) SetDomainId(v string) *DisassociateFraudsterInput { s.DomainId = &v return s } -// SetSpeakerId sets the SpeakerId field's value. -func (s *DescribeSpeakerInput) SetSpeakerId(v string) *DescribeSpeakerInput { - s.SpeakerId = &v +// SetFraudsterId sets the FraudsterId field's value. +func (s *DisassociateFraudsterInput) SetFraudsterId(v string) *DisassociateFraudsterInput { + s.FraudsterId = &v return s } -type DescribeSpeakerOutput struct { +// SetWatchlistId sets the WatchlistId field's value. +func (s *DisassociateFraudsterInput) SetWatchlistId(v string) *DisassociateFraudsterInput { + s.WatchlistId = &v + return s +} + +type DisassociateFraudsterOutput struct { _ struct{} `type:"structure"` - // Information about the specified speaker. - Speaker *Speaker `type:"structure"` + // Contains all the information about a fraudster. + Fraudster *Fraudster `type:"structure"` } // String returns the string representation. @@ -3496,7 +4971,7 @@ type DescribeSpeakerOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeSpeakerOutput) String() string { +func (s DisassociateFraudsterOutput) String() string { return awsutil.Prettify(s) } @@ -3505,13 +4980,13 @@ func (s DescribeSpeakerOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeSpeakerOutput) GoString() string { +func (s DisassociateFraudsterOutput) GoString() string { return s.String() } -// SetSpeaker sets the Speaker field's value. -func (s *DescribeSpeakerOutput) SetSpeaker(v *Speaker) *DescribeSpeakerOutput { - s.Speaker = v +// SetFraudster sets the Fraudster field's value. +func (s *DisassociateFraudsterOutput) SetFraudster(v *Fraudster) *DisassociateFraudsterOutput { + s.Fraudster = v return s } @@ -3522,23 +4997,23 @@ type Domain struct { // The Amazon Resource Name (ARN) for the domain. Arn *string `type:"string"` - // The timestamp at which the domain is created. + // The timestamp of when the domain was created. CreatedAt *time.Time `type:"timestamp"` - // The client-provided description of the domain. + // The description of the domain. // // Description is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Domain's // String and GoString methods. Description *string `min:"1" type:"string" sensitive:"true"` - // The service-generated identifier for the domain. + // The identifier of the domain. DomainId *string `min:"22" type:"string"` // The current status of the domain. DomainStatus *string `type:"string" enum:"DomainStatus"` - // The client-provided name for the domain. + // The name for the domain. // // Name is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Domain's @@ -3555,8 +5030,12 @@ type Domain struct { // is complete, the domain's data can only be accessed using the new KMS key. ServerSideEncryptionUpdateDetails *ServerSideEncryptionUpdateDetails `type:"structure"` - // The timestamp showing the domain's last update. + // The timestamp of when the domain was last update. UpdatedAt *time.Time `type:"timestamp"` + + // The watchlist details of a domain. Contains the default watchlist ID of the + // domain. + WatchlistDetails *WatchlistDetails `type:"structure"` } // String returns the string representation. @@ -3631,6 +5110,12 @@ func (s *Domain) SetUpdatedAt(v time.Time) *Domain { return s } +// SetWatchlistDetails sets the WatchlistDetails field's value. +func (s *Domain) SetWatchlistDetails(v *WatchlistDetails) *Domain { + s.WatchlistDetails = v + return s +} + // Contains a summary of information about a domain. type DomainSummary struct { _ struct{} `type:"structure"` @@ -3638,17 +5123,17 @@ type DomainSummary struct { // The Amazon Resource Name (ARN) for the domain. Arn *string `type:"string"` - // The timestamp showing when the domain is created. + // The timestamp of when the domain was created. CreatedAt *time.Time `type:"timestamp"` - // The client-provided description of the domain. + // The description of the domain. // // Description is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DomainSummary's // String and GoString methods. Description *string `min:"1" type:"string" sensitive:"true"` - // The service-generated identifier for the domain. + // The identifier of the domain. DomainId *string `min:"22" type:"string"` // The current status of the domain. @@ -3671,8 +5156,11 @@ type DomainSummary struct { // is complete, the domain's data can only be accessed using the new KMS key. ServerSideEncryptionUpdateDetails *ServerSideEncryptionUpdateDetails `type:"structure"` - // The timestamp showing the domain's last update. + // The timestamp of when the domain was last updated. UpdatedAt *time.Time `type:"timestamp"` + + // Provides information about watchlistDetails and DefaultWatchlistID. + WatchlistDetails *WatchlistDetails `type:"structure"` } // String returns the string representation. @@ -3747,6 +5235,12 @@ func (s *DomainSummary) SetUpdatedAt(v time.Time) *DomainSummary { return s } +// SetWatchlistDetails sets the WatchlistDetails field's value. +func (s *DomainSummary) SetWatchlistDetails(v *WatchlistDetails) *DomainSummary { + s.WatchlistDetails = v + return s +} + // Contains configurations defining enrollment behavior for the batch job. type EnrollmentConfig struct { _ struct{} `type:"structure"` @@ -3780,6 +5274,21 @@ func (s EnrollmentConfig) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EnrollmentConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnrollmentConfig"} + if s.FraudDetectionConfig != nil { + if err := s.FraudDetectionConfig.Validate(); err != nil { + invalidParams.AddNested("FraudDetectionConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetExistingEnrollmentAction sets the ExistingEnrollmentAction field's value. func (s *EnrollmentConfig) SetExistingEnrollmentAction(v string) *EnrollmentConfig { s.ExistingEnrollmentAction = &v @@ -3792,9 +5301,8 @@ func (s *EnrollmentConfig) SetFraudDetectionConfig(v *EnrollmentJobFraudDetectio return s } -// The configuration defining the action to take when a speaker is flagged by -// the fraud detection system during a batch speaker enrollment job, and the -// risk threshold to use for identification. +// The fraud detection configuration to be used during the batch speaker enrollment +// job. type EnrollmentJobFraudDetectionConfig struct { _ struct{} `type:"structure"` @@ -3808,6 +5316,9 @@ type EnrollmentJobFraudDetectionConfig struct { // fraudulent. If the detected risk score calculated by Voice ID is greater // than or equal to the threshold, the speaker is considered a fraudster. RiskThreshold *int64 `type:"integer"` + + // The identifier of watchlists against which fraud detection is performed. + WatchlistIds []*string `min:"1" type:"list"` } // String returns the string representation. @@ -3828,6 +5339,19 @@ func (s EnrollmentJobFraudDetectionConfig) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *EnrollmentJobFraudDetectionConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnrollmentJobFraudDetectionConfig"} + if s.WatchlistIds != nil && len(s.WatchlistIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetFraudDetectionAction sets the FraudDetectionAction field's value. func (s *EnrollmentJobFraudDetectionConfig) SetFraudDetectionAction(v string) *EnrollmentJobFraudDetectionConfig { s.FraudDetectionAction = &v @@ -3840,6 +5364,12 @@ func (s *EnrollmentJobFraudDetectionConfig) SetRiskThreshold(v int64) *Enrollmen return s } +// SetWatchlistIds sets the WatchlistIds field's value. +func (s *EnrollmentJobFraudDetectionConfig) SetWatchlistIds(v []*string) *EnrollmentJobFraudDetectionConfig { + s.WatchlistIds = v + return s +} + type EvaluateSessionInput struct { _ struct{} `type:"structure"` @@ -3914,7 +5444,7 @@ type EvaluateSessionOutput struct { // decision and authentication score. AuthenticationResult *AuthenticationResult `type:"structure"` - // The identifier of the domain containing the session. + // The identifier of the domain that contains the session. DomainId *string `min:"22" type:"string"` // Details resulting from the fraud detection process, such as fraud detection @@ -4041,9 +5571,10 @@ type FraudDetectionConfiguration struct { // Threshold value for determining whether the speaker is a fraudster. If the // detected risk score calculated by Voice ID is higher than the threshold, // the speaker is considered a fraudster. - // - // RiskThreshold is a required field - RiskThreshold *int64 `type:"integer" required:"true"` + RiskThreshold *int64 `type:"integer"` + + // The identifier of the watchlist against which fraud detection is performed. + WatchlistId *string `min:"22" type:"string"` } // String returns the string representation. @@ -4070,17 +5601,21 @@ func (s *FraudDetectionConfiguration) SetRiskThreshold(v int64) *FraudDetectionC return s } +// SetWatchlistId sets the WatchlistId field's value. +func (s *FraudDetectionConfiguration) SetWatchlistId(v string) *FraudDetectionConfiguration { + s.WatchlistId = &v + return s +} + // The fraud detection result produced by Voice ID, processed against the current // session state and streamed audio of the speaker. type FraudDetectionResult struct { _ struct{} `type:"structure"` - // A timestamp indicating when audio aggregation ended for this fraud detection - // result. + // A timestamp of when audio aggregation ended for this fraud detection result. AudioAggregationEndedAt *time.Time `type:"timestamp"` - // A timestamp indicating when audio aggregation started for this fraud detection - // result. + // A timestamp of when audio aggregation started for this fraud detection result. AudioAggregationStartedAt *time.Time `type:"timestamp"` // The FraudDetectionConfiguration used to generate this fraud detection result. @@ -4217,14 +5752,17 @@ func (s *FraudRiskDetails) SetVoiceSpoofingRisk(v *VoiceSpoofingRisk) *FraudRisk type Fraudster struct { _ struct{} `type:"structure"` - // The timestamp when Voice ID identified the fraudster. + // The timestamp of when Voice ID identified the fraudster. CreatedAt *time.Time `type:"timestamp"` - // The identifier for the domain containing the fraudster. + // The identifier of the domain that contains the fraudster. DomainId *string `min:"22" type:"string"` // The service-generated identifier for the fraudster. GeneratedFraudsterId *string `min:"25" type:"string"` + + // The identifier of the watchlists the fraudster is a part of. + WatchlistIds []*string `type:"list"` } // String returns the string representation. @@ -4263,11 +5801,17 @@ func (s *Fraudster) SetGeneratedFraudsterId(v string) *Fraudster { return s } +// SetWatchlistIds sets the WatchlistIds field's value. +func (s *Fraudster) SetWatchlistIds(v []*string) *Fraudster { + s.WatchlistIds = v + return s +} + // Contains all the information about a fraudster registration job. type FraudsterRegistrationJob struct { _ struct{} `type:"structure"` - // A timestamp showing the creation time of the fraudster registration job. + // A timestamp of when the fraudster registration job was created. CreatedAt *time.Time `type:"timestamp"` // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions @@ -4275,10 +5819,10 @@ type FraudsterRegistrationJob struct { // job output file. DataAccessRoleArn *string `min:"20" type:"string"` - // The identifier of the domain containing the fraudster registration job. + // The identifier of the domain that contains the fraudster registration job. DomainId *string `min:"22" type:"string"` - // A timestamp showing when the fraudster registration job ended. + // A timestamp of when the fraudster registration job ended. EndedAt *time.Time `type:"timestamp"` // Contains details that are populated when an entire batch job fails. In cases @@ -4414,13 +5958,13 @@ func (s *FraudsterRegistrationJob) SetRegistrationConfig(v *RegistrationConfig) type FraudsterRegistrationJobSummary struct { _ struct{} `type:"structure"` - // A timestamp showing when the fraudster registration job is created. + // A timestamp of when the fraudster registration job was created. CreatedAt *time.Time `type:"timestamp"` - // The identifier of the domain containing the fraudster registration job. + // The identifier of the domain that contains the fraudster registration job. DomainId *string `min:"22" type:"string"` - // A timestamp showing when the fraudster registration job ended. + // A timestamp of when the fraudster registration job ended. EndedAt *time.Time `type:"timestamp"` // Contains details that are populated when an entire batch job fails. In cases @@ -4514,6 +6058,65 @@ func (s *FraudsterRegistrationJobSummary) SetJobStatus(v string) *FraudsterRegis return s } +// Contains a summary of information about a fraudster. +type FraudsterSummary struct { + _ struct{} `type:"structure"` + + // The timestamp of when the fraudster summary was created. + CreatedAt *time.Time `type:"timestamp"` + + // The identifier of the domain that contains the fraudster summary. + DomainId *string `min:"22" type:"string"` + + // The service-generated identifier for the fraudster. + GeneratedFraudsterId *string `min:"25" type:"string"` + + // The identifier of the watchlists the fraudster is a part of. + WatchlistIds []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *FraudsterSummary) SetCreatedAt(v time.Time) *FraudsterSummary { + s.CreatedAt = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *FraudsterSummary) SetDomainId(v string) *FraudsterSummary { + s.DomainId = &v + return s +} + +// SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value. +func (s *FraudsterSummary) SetGeneratedFraudsterId(v string) *FraudsterSummary { + s.GeneratedFraudsterId = &v + return s +} + +// SetWatchlistIds sets the WatchlistIds field's value. +func (s *FraudsterSummary) SetWatchlistIds(v []*string) *FraudsterSummary { + s.WatchlistIds = v + return s +} + // The configuration containing input file information for a batch job. type InputDataConfig struct { _ struct{} `type:"structure"` @@ -4708,7 +6311,9 @@ func (s *KnownFraudsterRisk) SetRiskScore(v int64) *KnownFraudsterRisk { type ListDomainsInput struct { _ struct{} `type:"structure"` - // The maximum number of domains to list per API call. + // The maximum number of results that are returned per call. You can use NextToken + // to obtain more pages of results. The default is 100; the maximum allowed + // page size is also 100. MaxResults *int64 `min:"1" type:"integer"` // If NextToken is returned, there are more results available. The value of @@ -4807,7 +6412,7 @@ func (s *ListDomainsOutput) SetNextToken(v string) *ListDomainsOutput { type ListFraudsterRegistrationJobsInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the fraudster registration Jobs. + // The identifier of the domain that contains the fraudster registration Jobs. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -4816,7 +6421,7 @@ type ListFraudsterRegistrationJobsInput struct { JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"` // The maximum number of results that are returned per call. You can use NextToken - // to obtain further pages of results. The default is 100; the maximum allowed + // to obtain more pages of results. The default is 100; the maximum allowed // page size is also 100. MaxResults *int64 `min:"1" type:"integer"` @@ -4870,29 +6475,161 @@ func (s *ListFraudsterRegistrationJobsInput) SetDomainId(v string) *ListFraudste return s } -// SetJobStatus sets the JobStatus field's value. -func (s *ListFraudsterRegistrationJobsInput) SetJobStatus(v string) *ListFraudsterRegistrationJobsInput { - s.JobStatus = &v +// SetJobStatus sets the JobStatus field's value. +func (s *ListFraudsterRegistrationJobsInput) SetJobStatus(v string) *ListFraudsterRegistrationJobsInput { + s.JobStatus = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFraudsterRegistrationJobsInput) SetMaxResults(v int64) *ListFraudsterRegistrationJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFraudsterRegistrationJobsInput) SetNextToken(v string) *ListFraudsterRegistrationJobsInput { + s.NextToken = &v + return s +} + +type ListFraudsterRegistrationJobsOutput struct { + _ struct{} `type:"structure"` + + // A list containing details about each specified fraudster registration job. + JobSummaries []*FraudsterRegistrationJobSummary `type:"list"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsOutput) GoString() string { + return s.String() +} + +// SetJobSummaries sets the JobSummaries field's value. +func (s *ListFraudsterRegistrationJobsOutput) SetJobSummaries(v []*FraudsterRegistrationJobSummary) *ListFraudsterRegistrationJobsOutput { + s.JobSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFraudsterRegistrationJobsOutput) SetNextToken(v string) *ListFraudsterRegistrationJobsOutput { + s.NextToken = &v + return s +} + +type ListFraudstersInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain more pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` + + // The identifier of the watchlist. If provided, all fraudsters in the watchlist + // are listed. If not provided, all fraudsters in the domain are listed. + WatchlistId *string `min:"22" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudstersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudstersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFraudstersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFraudstersInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *ListFraudstersInput) SetDomainId(v string) *ListFraudstersInput { + s.DomainId = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListFraudsterRegistrationJobsInput) SetMaxResults(v int64) *ListFraudsterRegistrationJobsInput { +func (s *ListFraudstersInput) SetMaxResults(v int64) *ListFraudstersInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListFraudsterRegistrationJobsInput) SetNextToken(v string) *ListFraudsterRegistrationJobsInput { +func (s *ListFraudstersInput) SetNextToken(v string) *ListFraudstersInput { s.NextToken = &v return s } -type ListFraudsterRegistrationJobsOutput struct { +// SetWatchlistId sets the WatchlistId field's value. +func (s *ListFraudstersInput) SetWatchlistId(v string) *ListFraudstersInput { + s.WatchlistId = &v + return s +} + +type ListFraudstersOutput struct { _ struct{} `type:"structure"` - // A list containing details about each specified fraudster registration job. - JobSummaries []*FraudsterRegistrationJobSummary `type:"list"` + // A list that contains details about each fraudster in the Amazon Web Services + // account. + FraudsterSummaries []*FraudsterSummary `type:"list"` // If NextToken is returned, there are more results available. The value of // NextToken is a unique pagination token for each page. Make the call again @@ -4906,7 +6643,7 @@ type ListFraudsterRegistrationJobsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFraudsterRegistrationJobsOutput) String() string { +func (s ListFraudstersOutput) String() string { return awsutil.Prettify(s) } @@ -4915,18 +6652,18 @@ func (s ListFraudsterRegistrationJobsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListFraudsterRegistrationJobsOutput) GoString() string { +func (s ListFraudstersOutput) GoString() string { return s.String() } -// SetJobSummaries sets the JobSummaries field's value. -func (s *ListFraudsterRegistrationJobsOutput) SetJobSummaries(v []*FraudsterRegistrationJobSummary) *ListFraudsterRegistrationJobsOutput { - s.JobSummaries = v +// SetFraudsterSummaries sets the FraudsterSummaries field's value. +func (s *ListFraudstersOutput) SetFraudsterSummaries(v []*FraudsterSummary) *ListFraudstersOutput { + s.FraudsterSummaries = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListFraudsterRegistrationJobsOutput) SetNextToken(v string) *ListFraudsterRegistrationJobsOutput { +func (s *ListFraudstersOutput) SetNextToken(v string) *ListFraudstersOutput { s.NextToken = &v return s } @@ -4934,7 +6671,7 @@ func (s *ListFraudsterRegistrationJobsOutput) SetNextToken(v string) *ListFrauds type ListSpeakerEnrollmentJobsInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the speaker enrollment jobs. + // The identifier of the domain that contains the speaker enrollment jobs. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -4943,7 +6680,7 @@ type ListSpeakerEnrollmentJobsInput struct { JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"` // The maximum number of results that are returned per call. You can use NextToken - // to obtain further pages of results. The default is 100; the maximum allowed + // to obtain more pages of results. The default is 100; the maximum allowed // page size is also 100. MaxResults *int64 `min:"1" type:"integer"` @@ -5067,7 +6804,7 @@ type ListSpeakersInput struct { DomainId *string `min:"22" type:"string" required:"true"` // The maximum number of results that are returned per call. You can use NextToken - // to obtain further pages of results. The default is 100; the maximum allowed + // to obtain more pages of results. The default is 100; the maximum allowed // page size is also 100. MaxResults *int64 `min:"1" type:"integer"` @@ -5257,10 +6994,129 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput return s } +type ListWatchlistsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain more pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWatchlistsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWatchlistsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListWatchlistsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWatchlistsInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *ListWatchlistsInput) SetDomainId(v string) *ListWatchlistsInput { + s.DomainId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListWatchlistsInput) SetMaxResults(v int64) *ListWatchlistsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWatchlistsInput) SetNextToken(v string) *ListWatchlistsInput { + s.NextToken = &v + return s +} + +type ListWatchlistsOutput struct { + _ struct{} `type:"structure"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` + + // A list that contains details about each watchlist in the Amazon Web Services + // account. + WatchlistSummaries []*WatchlistSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWatchlistsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListWatchlistsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListWatchlistsOutput) SetNextToken(v string) *ListWatchlistsOutput { + s.NextToken = &v + return s +} + +// SetWatchlistSummaries sets the WatchlistSummaries field's value. +func (s *ListWatchlistsOutput) SetWatchlistSummaries(v []*WatchlistSummary) *ListWatchlistsOutput { + s.WatchlistSummaries = v + return s +} + type OptOutSpeakerInput struct { _ struct{} `type:"structure"` - // The identifier of the domain containing the speaker. + // The identifier of the domain that contains the speaker. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -5421,9 +7277,8 @@ func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig { return s } -// The configuration defining the action to take when a duplicate fraudster -// is detected, and the similarity threshold to use for detecting a duplicate -// fraudster during a batch fraudster registration job. +// The registration configuration to be used during the batch fraudster registration +// job. type RegistrationConfig struct { _ struct{} `type:"structure"` @@ -5436,6 +7291,10 @@ type RegistrationConfig struct { // The minimum similarity score between the new and old fraudsters in order // to consider the new fraudster a duplicate. FraudsterSimilarityThreshold *int64 `type:"integer"` + + // The identifiers of watchlists that a fraudster is registered to. If a watchlist + // isn't provided, the fraudsters are registered to the default watchlist. + WatchlistIds []*string `min:"1" type:"list"` } // String returns the string representation. @@ -5456,6 +7315,19 @@ func (s RegistrationConfig) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *RegistrationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RegistrationConfig"} + if s.WatchlistIds != nil && len(s.WatchlistIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDuplicateRegistrationAction sets the DuplicateRegistrationAction field's value. func (s *RegistrationConfig) SetDuplicateRegistrationAction(v string) *RegistrationConfig { s.DuplicateRegistrationAction = &v @@ -5468,6 +7340,12 @@ func (s *RegistrationConfig) SetFraudsterSimilarityThreshold(v int64) *Registrat return s } +// SetWatchlistIds sets the WatchlistIds field's value. +func (s *RegistrationConfig) SetWatchlistIds(v []*string) *RegistrationConfig { + s.WatchlistIds = v + return s +} + // The specified resource cannot be found. Check the ResourceType and error // message for more details. type ResourceNotFoundException struct { @@ -5718,7 +7596,7 @@ func (s *ServiceQuotaExceededException) RequestID() string { type Speaker struct { _ struct{} `type:"structure"` - // A timestamp showing when the speaker is created. + // A timestamp of when the speaker was created. CreatedAt *time.Time `type:"timestamp"` // The client-provided identifier for the speaker. @@ -5734,14 +7612,14 @@ type Speaker struct { // The service-generated identifier for the speaker. GeneratedSpeakerId *string `min:"25" type:"string"` - // The timestamp when the speaker was last accessed for enrollment, re-enrollment + // The timestamp of when the speaker was last accessed for enrollment, re-enrollment // or a successful authentication. This timestamp is accurate to one hour. LastAccessedAt *time.Time `type:"timestamp"` // The current status of the speaker. Status *string `type:"string" enum:"SpeakerStatus"` - // A timestamp showing the speaker's last update. + // A timestamp of the speaker's last update. UpdatedAt *time.Time `type:"timestamp"` } @@ -5809,7 +7687,7 @@ func (s *Speaker) SetUpdatedAt(v time.Time) *Speaker { type SpeakerEnrollmentJob struct { _ struct{} `type:"structure"` - // A timestamp showing the creation of the speaker enrollment job. + // A timestamp of when the speaker enrollment job was created. CreatedAt *time.Time `type:"timestamp"` // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions @@ -5820,7 +7698,7 @@ type SpeakerEnrollmentJob struct { // The identifier of the domain that contains the speaker enrollment job. DomainId *string `min:"22" type:"string"` - // A timestamp showing when the speaker enrollment job ended. + // A timestamp of when the speaker enrollment job ended. EndedAt *time.Time `type:"timestamp"` // The configuration that defines the action to take when the speaker is already @@ -5954,13 +7832,13 @@ func (s *SpeakerEnrollmentJob) SetOutputDataConfig(v *OutputDataConfig) *Speaker type SpeakerEnrollmentJobSummary struct { _ struct{} `type:"structure"` - // A timestamp showing the creation time of the speaker enrollment job. + // A timestamp of when of the speaker enrollment job was created. CreatedAt *time.Time `type:"timestamp"` // The identifier of the domain that contains the speaker enrollment job. DomainId *string `min:"22" type:"string"` - // A timestamp showing when the speaker enrollment job ended. + // A timestamp of when the speaker enrollment job ended. EndedAt *time.Time `type:"timestamp"` // Contains details that are populated when an entire batch job fails. In cases @@ -6148,8 +8026,10 @@ func (s *SpeakerSummary) SetUpdatedAt(v time.Time) *SpeakerSummary { type StartFraudsterRegistrationJobInput struct { _ struct{} `type:"structure"` - // The idempotency token for starting a new fraudster registration job. If not - // provided, Amazon Web Services SDK populates this field. + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. If not provided, the Amazon Web Services SDK populates this + // field. For more information about idempotency, see Making retries safe with + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions @@ -6160,8 +8040,8 @@ type StartFraudsterRegistrationJobInput struct { // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` - // The identifier of the domain containing the fraudster registration job and - // in which the fraudsters are registered. + // The identifier of the domain that contains the fraudster registration job + // and in which the fraudsters are registered. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` @@ -6246,6 +8126,11 @@ func (s *StartFraudsterRegistrationJobInput) Validate() error { invalidParams.AddNested("OutputDataConfig", err.(request.ErrInvalidParams)) } } + if s.RegistrationConfig != nil { + if err := s.RegistrationConfig.Validate(); err != nil { + invalidParams.AddNested("RegistrationConfig", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -6329,8 +8214,10 @@ func (s *StartFraudsterRegistrationJobOutput) SetJob(v *FraudsterRegistrationJob type StartSpeakerEnrollmentJobInput struct { _ struct{} `type:"structure"` - // The idempotency token for starting a new speaker enrollment Job. If not provided, - // Amazon Web Services SDK populates this field. + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. If not provided, the Amazon Web Services SDK populates this + // field. For more information about idempotency, see Making retries safe with + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions @@ -6418,6 +8305,11 @@ func (s *StartSpeakerEnrollmentJobInput) Validate() error { if s.OutputDataConfig == nil { invalidParams.Add(request.NewErrParamRequired("OutputDataConfig")) } + if s.EnrollmentConfig != nil { + if err := s.EnrollmentConfig.Validate(); err != nil { + invalidParams.AddNested("EnrollmentConfig", err.(request.ErrInvalidParams)) + } + } if s.InputDataConfig != nil { if err := s.InputDataConfig.Validate(); err != nil { invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) @@ -6783,11 +8675,131 @@ func (s *UntagResourceInput) Validate() error { if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateDomainInput struct { + _ struct{} `type:"structure"` + + // A brief description about this domain. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateDomainInput's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain to be updated. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The name of the domain. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateDomainInput's + // String and GoString methods. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // The configuration, containing the KMS key identifier, to be used by Voice + // ID for the server-side encryption of your data. Changing the domain's associated + // KMS key immediately triggers an asynchronous process to remove dependency + // on the old KMS key, such that the domain's data can only be accessed using + // the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains + // the details for this process. + // + // ServerSideEncryptionConfiguration is a required field + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDomainInput"} + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ServerSideEncryptionConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ServerSideEncryptionConfiguration")) } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) + if s.ServerSideEncryptionConfiguration != nil { + if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -6796,20 +8808,35 @@ func (s *UntagResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { - s.ResourceArn = &v +// SetDescription sets the Description field's value. +func (s *UpdateDomainInput) SetDescription(v string) *UpdateDomainInput { + s.Description = &v return s } -// SetTagKeys sets the TagKeys field's value. -func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { - s.TagKeys = v +// SetDomainId sets the DomainId field's value. +func (s *UpdateDomainInput) SetDomainId(v string) *UpdateDomainInput { + s.DomainId = &v return s } -type UntagResourceOutput struct { +// SetName sets the Name field's value. +func (s *UpdateDomainInput) SetName(v string) *UpdateDomainInput { + s.Name = &v + return s +} + +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *UpdateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *UpdateDomainInput { + s.ServerSideEncryptionConfiguration = v + return s +} + +type UpdateDomainOutput struct { _ struct{} `type:"structure"` + + // Details about the updated domain + Domain *Domain `type:"structure"` } // String returns the string representation. @@ -6817,7 +8844,7 @@ type UntagResourceOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UntagResourceOutput) String() string { +func (s UpdateDomainOutput) String() string { return awsutil.Prettify(s) } @@ -6826,43 +8853,42 @@ func (s UntagResourceOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UntagResourceOutput) GoString() string { +func (s UpdateDomainOutput) GoString() string { return s.String() } -type UpdateDomainInput struct { +// SetDomain sets the Domain field's value. +func (s *UpdateDomainOutput) SetDomain(v *Domain) *UpdateDomainOutput { + s.Domain = v + return s +} + +type UpdateWatchlistInput struct { _ struct{} `type:"structure"` - // A brief description of the domain. + // A brief description about this watchlist. // // Description is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by UpdateDomainInput's + // replaced with "sensitive" in string returned by UpdateWatchlistInput's // String and GoString methods. Description *string `min:"1" type:"string" sensitive:"true"` - // The identifier of the domain to be updated. + // The identifier of the domain that contains the watchlist. // // DomainId is a required field DomainId *string `min:"22" type:"string" required:"true"` - // The name of the domain. + // The name of the watchlist. // // Name is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by UpdateDomainInput's + // replaced with "sensitive" in string returned by UpdateWatchlistInput's // String and GoString methods. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + Name *string `min:"1" type:"string" sensitive:"true"` - // The configuration, containing the KMS key identifier, to be used by Voice - // ID for the server-side encryption of your data. Changing the domain's associated - // KMS key immediately triggers an asynchronous process to remove dependency - // on the old KMS key, such that the domain's data can only be accessed using - // the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains - // the details for this process. + // The identifier of the watchlist to be updated. // - // ServerSideEncryptionConfiguration is a required field - ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"` + // WatchlistId is a required field + WatchlistId *string `min:"22" type:"string" required:"true"` } // String returns the string representation. @@ -6870,7 +8896,7 @@ type UpdateDomainInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UpdateDomainInput) String() string { +func (s UpdateWatchlistInput) String() string { return awsutil.Prettify(s) } @@ -6879,13 +8905,13 @@ func (s UpdateDomainInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UpdateDomainInput) GoString() string { +func (s UpdateWatchlistInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateDomainInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateDomainInput"} +func (s *UpdateWatchlistInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateWatchlistInput"} if s.Description != nil && len(*s.Description) < 1 { invalidParams.Add(request.NewErrParamMinLen("Description", 1)) } @@ -6895,19 +8921,14 @@ func (s *UpdateDomainInput) Validate() error { if s.DomainId != nil && len(*s.DomainId) < 22 { invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.ServerSideEncryptionConfiguration == nil { - invalidParams.Add(request.NewErrParamRequired("ServerSideEncryptionConfiguration")) + if s.WatchlistId == nil { + invalidParams.Add(request.NewErrParamRequired("WatchlistId")) } - if s.ServerSideEncryptionConfiguration != nil { - if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { - invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) - } + if s.WatchlistId != nil && len(*s.WatchlistId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("WatchlistId", 22)) } if invalidParams.Len() > 0 { @@ -6917,34 +8938,34 @@ func (s *UpdateDomainInput) Validate() error { } // SetDescription sets the Description field's value. -func (s *UpdateDomainInput) SetDescription(v string) *UpdateDomainInput { +func (s *UpdateWatchlistInput) SetDescription(v string) *UpdateWatchlistInput { s.Description = &v return s } // SetDomainId sets the DomainId field's value. -func (s *UpdateDomainInput) SetDomainId(v string) *UpdateDomainInput { +func (s *UpdateWatchlistInput) SetDomainId(v string) *UpdateWatchlistInput { s.DomainId = &v return s } // SetName sets the Name field's value. -func (s *UpdateDomainInput) SetName(v string) *UpdateDomainInput { +func (s *UpdateWatchlistInput) SetName(v string) *UpdateWatchlistInput { s.Name = &v return s } -// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. -func (s *UpdateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *UpdateDomainInput { - s.ServerSideEncryptionConfiguration = v +// SetWatchlistId sets the WatchlistId field's value. +func (s *UpdateWatchlistInput) SetWatchlistId(v string) *UpdateWatchlistInput { + s.WatchlistId = &v return s } -type UpdateDomainOutput struct { +type UpdateWatchlistOutput struct { _ struct{} `type:"structure"` - // Details about the updated domain - Domain *Domain `type:"structure"` + // Details about the updated watchlist. + Watchlist *Watchlist `type:"structure"` } // String returns the string representation. @@ -6952,7 +8973,7 @@ type UpdateDomainOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UpdateDomainOutput) String() string { +func (s UpdateWatchlistOutput) String() string { return awsutil.Prettify(s) } @@ -6961,13 +8982,13 @@ func (s UpdateDomainOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s UpdateDomainOutput) GoString() string { +func (s UpdateWatchlistOutput) GoString() string { return s.String() } -// SetDomain sets the Domain field's value. -func (s *UpdateDomainOutput) SetDomain(v *Domain) *UpdateDomainOutput { - s.Domain = v +// SetWatchlist sets the Watchlist field's value. +func (s *UpdateWatchlistOutput) SetWatchlist(v *Watchlist) *UpdateWatchlistOutput { + s.Watchlist = v return s } @@ -7070,6 +9091,228 @@ func (s *VoiceSpoofingRisk) SetRiskScore(v int64) *VoiceSpoofingRisk { return s } +// Contains all the information about a watchlist. +type Watchlist struct { + _ struct{} `type:"structure"` + + // The timestamp of when the watchlist was created. + CreatedAt *time.Time `type:"timestamp"` + + // Whether the specified watchlist is the default watchlist of a domain. + DefaultWatchlist *bool `type:"boolean"` + + // The description of the watchlist. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Watchlist's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain that contains the watchlist. + DomainId *string `min:"22" type:"string"` + + // The name for the watchlist. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Watchlist's + // String and GoString methods. + Name *string `min:"1" type:"string" sensitive:"true"` + + // The timestamp of when the watchlist was updated. + UpdatedAt *time.Time `type:"timestamp"` + + // The identifier of the watchlist. + WatchlistId *string `min:"22" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Watchlist) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Watchlist) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Watchlist) SetCreatedAt(v time.Time) *Watchlist { + s.CreatedAt = &v + return s +} + +// SetDefaultWatchlist sets the DefaultWatchlist field's value. +func (s *Watchlist) SetDefaultWatchlist(v bool) *Watchlist { + s.DefaultWatchlist = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Watchlist) SetDescription(v string) *Watchlist { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *Watchlist) SetDomainId(v string) *Watchlist { + s.DomainId = &v + return s +} + +// SetName sets the Name field's value. +func (s *Watchlist) SetName(v string) *Watchlist { + s.Name = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *Watchlist) SetUpdatedAt(v time.Time) *Watchlist { + s.UpdatedAt = &v + return s +} + +// SetWatchlistId sets the WatchlistId field's value. +func (s *Watchlist) SetWatchlistId(v string) *Watchlist { + s.WatchlistId = &v + return s +} + +// Details of the watchlists in a domain. +type WatchlistDetails struct { + _ struct{} `type:"structure"` + + // The identifier of the default watchlist. + // + // DefaultWatchlistId is a required field + DefaultWatchlistId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WatchlistDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WatchlistDetails) GoString() string { + return s.String() +} + +// SetDefaultWatchlistId sets the DefaultWatchlistId field's value. +func (s *WatchlistDetails) SetDefaultWatchlistId(v string) *WatchlistDetails { + s.DefaultWatchlistId = &v + return s +} + +// Contains a summary of information about a watchlist. +type WatchlistSummary struct { + _ struct{} `type:"structure"` + + // The timestamp of when the watchlist was created. + CreatedAt *time.Time `type:"timestamp"` + + // Whether the specified watchlist is the default watchlist of a domain. + DefaultWatchlist *bool `type:"boolean"` + + // The description of the watchlist. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by WatchlistSummary's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain that contains the watchlist. + DomainId *string `min:"22" type:"string"` + + // The name for the watchlist. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by WatchlistSummary's + // String and GoString methods. + Name *string `min:"1" type:"string" sensitive:"true"` + + // The timestamp of when the watchlist was last updated. + UpdatedAt *time.Time `type:"timestamp"` + + // The identifier of the watchlist. + WatchlistId *string `min:"22" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WatchlistSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s WatchlistSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *WatchlistSummary) SetCreatedAt(v time.Time) *WatchlistSummary { + s.CreatedAt = &v + return s +} + +// SetDefaultWatchlist sets the DefaultWatchlist field's value. +func (s *WatchlistSummary) SetDefaultWatchlist(v bool) *WatchlistSummary { + s.DefaultWatchlist = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *WatchlistSummary) SetDescription(v string) *WatchlistSummary { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *WatchlistSummary) SetDomainId(v string) *WatchlistSummary { + s.DomainId = &v + return s +} + +// SetName sets the Name field's value. +func (s *WatchlistSummary) SetName(v string) *WatchlistSummary { + s.Name = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *WatchlistSummary) SetUpdatedAt(v time.Time) *WatchlistSummary { + s.UpdatedAt = &v + return s +} + +// SetWatchlistId sets the WatchlistId field's value. +func (s *WatchlistSummary) SetWatchlistId(v string) *WatchlistSummary { + s.WatchlistId = &v + return s +} + const ( // AuthenticationDecisionAccept is a AuthenticationDecision enum value AuthenticationDecisionAccept = "ACCEPT" @@ -7130,6 +9373,12 @@ const ( // ConflictTypeDomainLockedFromEncryptionUpdates is a ConflictType enum value ConflictTypeDomainLockedFromEncryptionUpdates = "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES" + + // ConflictTypeCannotDeleteNonEmptyWatchlist is a ConflictType enum value + ConflictTypeCannotDeleteNonEmptyWatchlist = "CANNOT_DELETE_NON_EMPTY_WATCHLIST" + + // ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist is a ConflictType enum value + ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist = "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST" ) // ConflictType_Values returns all elements of the ConflictType enum @@ -7143,6 +9392,8 @@ func ConflictType_Values() []string { ConflictTypeSpeakerOptedOut, ConflictTypeConcurrentChanges, ConflictTypeDomainLockedFromEncryptionUpdates, + ConflictTypeCannotDeleteNonEmptyWatchlist, + ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist, } } @@ -7296,6 +9547,9 @@ const ( // ResourceTypeSpeaker is a ResourceType enum value ResourceTypeSpeaker = "SPEAKER" + + // ResourceTypeWatchlist is a ResourceType enum value + ResourceTypeWatchlist = "WATCHLIST" ) // ResourceType_Values returns all elements of the ResourceType enum @@ -7307,6 +9561,7 @@ func ResourceType_Values() []string { ResourceTypeFraudster, ResourceTypeSession, ResourceTypeSpeaker, + ResourceTypeWatchlist, } } diff --git a/service/voiceid/doc.go b/service/voiceid/doc.go index 73fa6b238c5..1c9ab61136f 100644 --- a/service/voiceid/doc.go +++ b/service/voiceid/doc.go @@ -4,7 +4,8 @@ // requests to Amazon Voice ID. // // Amazon Connect Voice ID provides real-time caller authentication and fraud -// screening. This guide describes the APIs used for this service. +// risk detection, which make voice interactions in contact centers more secure +// and efficient. // // See https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27 for more information on this service. // diff --git a/service/voiceid/voiceidiface/interface.go b/service/voiceid/voiceidiface/interface.go index 0196a0b3924..9ae065ae26f 100644 --- a/service/voiceid/voiceidiface/interface.go +++ b/service/voiceid/voiceidiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // Amazon Voice ID. // func myFunc(svc voiceidiface.VoiceIDAPI) bool { -// // Make svc.CreateDomain request +// // Make svc.AssociateFraudster request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockVoiceIDClient struct { // voiceidiface.VoiceIDAPI // } -// func (m *mockVoiceIDClient) CreateDomain(input *voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error) { +// func (m *mockVoiceIDClient) AssociateFraudster(input *voiceid.AssociateFraudsterInput) (*voiceid.AssociateFraudsterOutput, error) { // // mock response/functionality // } // @@ -60,10 +60,18 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type VoiceIDAPI interface { + AssociateFraudster(*voiceid.AssociateFraudsterInput) (*voiceid.AssociateFraudsterOutput, error) + AssociateFraudsterWithContext(aws.Context, *voiceid.AssociateFraudsterInput, ...request.Option) (*voiceid.AssociateFraudsterOutput, error) + AssociateFraudsterRequest(*voiceid.AssociateFraudsterInput) (*request.Request, *voiceid.AssociateFraudsterOutput) + CreateDomain(*voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error) CreateDomainWithContext(aws.Context, *voiceid.CreateDomainInput, ...request.Option) (*voiceid.CreateDomainOutput, error) CreateDomainRequest(*voiceid.CreateDomainInput) (*request.Request, *voiceid.CreateDomainOutput) + CreateWatchlist(*voiceid.CreateWatchlistInput) (*voiceid.CreateWatchlistOutput, error) + CreateWatchlistWithContext(aws.Context, *voiceid.CreateWatchlistInput, ...request.Option) (*voiceid.CreateWatchlistOutput, error) + CreateWatchlistRequest(*voiceid.CreateWatchlistInput) (*request.Request, *voiceid.CreateWatchlistOutput) + DeleteDomain(*voiceid.DeleteDomainInput) (*voiceid.DeleteDomainOutput, error) DeleteDomainWithContext(aws.Context, *voiceid.DeleteDomainInput, ...request.Option) (*voiceid.DeleteDomainOutput, error) DeleteDomainRequest(*voiceid.DeleteDomainInput) (*request.Request, *voiceid.DeleteDomainOutput) @@ -76,6 +84,10 @@ type VoiceIDAPI interface { DeleteSpeakerWithContext(aws.Context, *voiceid.DeleteSpeakerInput, ...request.Option) (*voiceid.DeleteSpeakerOutput, error) DeleteSpeakerRequest(*voiceid.DeleteSpeakerInput) (*request.Request, *voiceid.DeleteSpeakerOutput) + DeleteWatchlist(*voiceid.DeleteWatchlistInput) (*voiceid.DeleteWatchlistOutput, error) + DeleteWatchlistWithContext(aws.Context, *voiceid.DeleteWatchlistInput, ...request.Option) (*voiceid.DeleteWatchlistOutput, error) + DeleteWatchlistRequest(*voiceid.DeleteWatchlistInput) (*request.Request, *voiceid.DeleteWatchlistOutput) + DescribeDomain(*voiceid.DescribeDomainInput) (*voiceid.DescribeDomainOutput, error) DescribeDomainWithContext(aws.Context, *voiceid.DescribeDomainInput, ...request.Option) (*voiceid.DescribeDomainOutput, error) DescribeDomainRequest(*voiceid.DescribeDomainInput) (*request.Request, *voiceid.DescribeDomainOutput) @@ -96,6 +108,14 @@ type VoiceIDAPI interface { DescribeSpeakerEnrollmentJobWithContext(aws.Context, *voiceid.DescribeSpeakerEnrollmentJobInput, ...request.Option) (*voiceid.DescribeSpeakerEnrollmentJobOutput, error) DescribeSpeakerEnrollmentJobRequest(*voiceid.DescribeSpeakerEnrollmentJobInput) (*request.Request, *voiceid.DescribeSpeakerEnrollmentJobOutput) + DescribeWatchlist(*voiceid.DescribeWatchlistInput) (*voiceid.DescribeWatchlistOutput, error) + DescribeWatchlistWithContext(aws.Context, *voiceid.DescribeWatchlistInput, ...request.Option) (*voiceid.DescribeWatchlistOutput, error) + DescribeWatchlistRequest(*voiceid.DescribeWatchlistInput) (*request.Request, *voiceid.DescribeWatchlistOutput) + + DisassociateFraudster(*voiceid.DisassociateFraudsterInput) (*voiceid.DisassociateFraudsterOutput, error) + DisassociateFraudsterWithContext(aws.Context, *voiceid.DisassociateFraudsterInput, ...request.Option) (*voiceid.DisassociateFraudsterOutput, error) + DisassociateFraudsterRequest(*voiceid.DisassociateFraudsterInput) (*request.Request, *voiceid.DisassociateFraudsterOutput) + EvaluateSession(*voiceid.EvaluateSessionInput) (*voiceid.EvaluateSessionOutput, error) EvaluateSessionWithContext(aws.Context, *voiceid.EvaluateSessionInput, ...request.Option) (*voiceid.EvaluateSessionOutput, error) EvaluateSessionRequest(*voiceid.EvaluateSessionInput) (*request.Request, *voiceid.EvaluateSessionOutput) @@ -114,6 +134,13 @@ type VoiceIDAPI interface { ListFraudsterRegistrationJobsPages(*voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool) error ListFraudsterRegistrationJobsPagesWithContext(aws.Context, *voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool, ...request.Option) error + ListFraudsters(*voiceid.ListFraudstersInput) (*voiceid.ListFraudstersOutput, error) + ListFraudstersWithContext(aws.Context, *voiceid.ListFraudstersInput, ...request.Option) (*voiceid.ListFraudstersOutput, error) + ListFraudstersRequest(*voiceid.ListFraudstersInput) (*request.Request, *voiceid.ListFraudstersOutput) + + ListFraudstersPages(*voiceid.ListFraudstersInput, func(*voiceid.ListFraudstersOutput, bool) bool) error + ListFraudstersPagesWithContext(aws.Context, *voiceid.ListFraudstersInput, func(*voiceid.ListFraudstersOutput, bool) bool, ...request.Option) error + ListSpeakerEnrollmentJobs(*voiceid.ListSpeakerEnrollmentJobsInput) (*voiceid.ListSpeakerEnrollmentJobsOutput, error) ListSpeakerEnrollmentJobsWithContext(aws.Context, *voiceid.ListSpeakerEnrollmentJobsInput, ...request.Option) (*voiceid.ListSpeakerEnrollmentJobsOutput, error) ListSpeakerEnrollmentJobsRequest(*voiceid.ListSpeakerEnrollmentJobsInput) (*request.Request, *voiceid.ListSpeakerEnrollmentJobsOutput) @@ -132,6 +159,13 @@ type VoiceIDAPI interface { ListTagsForResourceWithContext(aws.Context, *voiceid.ListTagsForResourceInput, ...request.Option) (*voiceid.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*voiceid.ListTagsForResourceInput) (*request.Request, *voiceid.ListTagsForResourceOutput) + ListWatchlists(*voiceid.ListWatchlistsInput) (*voiceid.ListWatchlistsOutput, error) + ListWatchlistsWithContext(aws.Context, *voiceid.ListWatchlistsInput, ...request.Option) (*voiceid.ListWatchlistsOutput, error) + ListWatchlistsRequest(*voiceid.ListWatchlistsInput) (*request.Request, *voiceid.ListWatchlistsOutput) + + ListWatchlistsPages(*voiceid.ListWatchlistsInput, func(*voiceid.ListWatchlistsOutput, bool) bool) error + ListWatchlistsPagesWithContext(aws.Context, *voiceid.ListWatchlistsInput, func(*voiceid.ListWatchlistsOutput, bool) bool, ...request.Option) error + OptOutSpeaker(*voiceid.OptOutSpeakerInput) (*voiceid.OptOutSpeakerOutput, error) OptOutSpeakerWithContext(aws.Context, *voiceid.OptOutSpeakerInput, ...request.Option) (*voiceid.OptOutSpeakerOutput, error) OptOutSpeakerRequest(*voiceid.OptOutSpeakerInput) (*request.Request, *voiceid.OptOutSpeakerOutput) @@ -155,6 +189,10 @@ type VoiceIDAPI interface { UpdateDomain(*voiceid.UpdateDomainInput) (*voiceid.UpdateDomainOutput, error) UpdateDomainWithContext(aws.Context, *voiceid.UpdateDomainInput, ...request.Option) (*voiceid.UpdateDomainOutput, error) UpdateDomainRequest(*voiceid.UpdateDomainInput) (*request.Request, *voiceid.UpdateDomainOutput) + + UpdateWatchlist(*voiceid.UpdateWatchlistInput) (*voiceid.UpdateWatchlistOutput, error) + UpdateWatchlistWithContext(aws.Context, *voiceid.UpdateWatchlistInput, ...request.Option) (*voiceid.UpdateWatchlistOutput, error) + UpdateWatchlistRequest(*voiceid.UpdateWatchlistInput) (*request.Request, *voiceid.UpdateWatchlistOutput) } var _ VoiceIDAPI = (*voiceid.VoiceID)(nil)