From df5d06eec1beb3068046d1bc6fe32086b952c659 Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Fri, 24 May 2024 10:04:05 -0700 Subject: [PATCH 1/7] Remove honeycode client following the service deprecation (#3186) --- .../api-change-honeycode-76024.json | 5 + botocore/data/endpoints.json | 5 - .../2020-03-01/endpoint-rule-set-1.json | 314 --- .../data/honeycode/2020-03-01/examples-1.json | 5 - .../honeycode/2020-03-01/paginators-1.json | 27 - .../2020-03-01/paginators-1.sdk-extras.json | 30 - .../data/honeycode/2020-03-01/service-2.json | 1833 ----------------- .../honeycode/endpoint-tests-1.json | 327 --- 8 files changed, 5 insertions(+), 2541 deletions(-) create mode 100644 .changes/next-release/api-change-honeycode-76024.json delete mode 100644 botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json delete mode 100644 botocore/data/honeycode/2020-03-01/examples-1.json delete mode 100644 botocore/data/honeycode/2020-03-01/paginators-1.json delete mode 100644 botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json delete mode 100644 botocore/data/honeycode/2020-03-01/service-2.json delete mode 100644 tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json diff --git a/.changes/next-release/api-change-honeycode-76024.json b/.changes/next-release/api-change-honeycode-76024.json new file mode 100644 index 0000000000..44d7760cb2 --- /dev/null +++ b/.changes/next-release/api-change-honeycode-76024.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``honeycode``", + "description": "The honeycode client has been removed following the deprecation of the service." +} diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 998cfec67f..243af2b794 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -8953,11 +8953,6 @@ "us-west-2" : { } } }, - "honeycode" : { - "endpoints" : { - "us-west-2" : { } - } - }, "iam" : { "endpoints" : { "aws-global" : { diff --git a/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json b/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json deleted file mode 100644 index e485bc8046..0000000000 --- a/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "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": [ - { - "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": [ - { - "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": [], - "endpoint": { - "url": "https://honeycode-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": [], - "endpoint": { - "url": "https://honeycode-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": [], - "endpoint": { - "url": "https://honeycode.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://honeycode.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/botocore/data/honeycode/2020-03-01/examples-1.json b/botocore/data/honeycode/2020-03-01/examples-1.json deleted file mode 100644 index 0ea7e3b0bb..0000000000 --- a/botocore/data/honeycode/2020-03-01/examples-1.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": "1.0", - "examples": { - } -} diff --git a/botocore/data/honeycode/2020-03-01/paginators-1.json b/botocore/data/honeycode/2020-03-01/paginators-1.json deleted file mode 100644 index 19ba884c5e..0000000000 --- a/botocore/data/honeycode/2020-03-01/paginators-1.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "pagination": { - "ListTableColumns": { - "input_token": "nextToken", - "output_token": "nextToken", - "result_key": "tableColumns" - }, - "ListTableRows": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "rows" - }, - "ListTables": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "tables" - }, - "QueryTableRows": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "rows" - } - } -} diff --git a/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json b/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json deleted file mode 100644 index bcdc190050..0000000000 --- a/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "version": 1.0, - "merge": { - "pagination": { - "ListTableColumns": { - "non_aggregate_keys": [ - "workbookCursor" - ] - }, - "ListTableRows": { - "non_aggregate_keys": [ - "workbookCursor", - "columnIds", - "rowIdsNotFound" - ] - }, - "ListTables": { - "non_aggregate_keys": [ - "workbookCursor" - ] - }, - "QueryTableRows": { - "non_aggregate_keys": [ - "workbookCursor", - "columnIds" - ] - } - } - } -} \ No newline at end of file diff --git a/botocore/data/honeycode/2020-03-01/service-2.json b/botocore/data/honeycode/2020-03-01/service-2.json deleted file mode 100644 index 74c726cfe4..0000000000 --- a/botocore/data/honeycode/2020-03-01/service-2.json +++ /dev/null @@ -1,1833 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2020-03-01", - "endpointPrefix":"honeycode", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceAbbreviation":"Honeycode", - "serviceFullName":"Amazon Honeycode", - "serviceId":"Honeycode", - "signatureVersion":"v4", - "signingName":"honeycode", - "uid":"honeycode-2020-03-01" - }, - "operations":{ - "BatchCreateTableRows":{ - "name":"BatchCreateTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchcreate" - }, - "input":{"shape":"BatchCreateTableRowsRequest"}, - "output":{"shape":"BatchCreateTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

" - }, - "BatchDeleteTableRows":{ - "name":"BatchDeleteTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchdelete" - }, - "input":{"shape":"BatchDeleteTableRowsRequest"}, - "output":{"shape":"BatchDeleteTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ValidationException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

" - }, - "BatchUpdateTableRows":{ - "name":"BatchUpdateTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchupdate" - }, - "input":{"shape":"BatchUpdateTableRowsRequest"}, - "output":{"shape":"BatchUpdateTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ValidationException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (\"\").

" - }, - "BatchUpsertTableRows":{ - "name":"BatchUpsertTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchupsert" - }, - "input":{"shape":"BatchUpsertTableRowsRequest"}, - "output":{"shape":"BatchUpsertTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (\"\").

" - }, - "DescribeTableDataImportJob":{ - "name":"DescribeTableDataImportJob", - "http":{ - "method":"GET", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/import/{jobId}" - }, - "input":{"shape":"DescribeTableDataImportJobRequest"}, - "output":{"shape":"DescribeTableDataImportJobResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"RequestTimeoutException"} - ], - "documentation":"

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

" - }, - "GetScreenData":{ - "name":"GetScreenData", - "http":{ - "method":"POST", - "requestUri":"/screendata" - }, - "input":{"shape":"GetScreenDataRequest"}, - "output":{"shape":"GetScreenDataResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

" - }, - "InvokeScreenAutomation":{ - "name":"InvokeScreenAutomation", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}" - }, - "input":{"shape":"InvokeScreenAutomationRequest"}, - "output":{"shape":"InvokeScreenAutomationResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"AutomationExecutionException"}, - {"shape":"AutomationExecutionTimeoutException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

" - }, - "ListTableColumns":{ - "name":"ListTableColumns", - "http":{ - "method":"GET", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/columns" - }, - "input":{"shape":"ListTableColumnsRequest"}, - "output":{"shape":"ListTableColumnsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

" - }, - "ListTableRows":{ - "name":"ListTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/list" - }, - "input":{"shape":"ListTableRowsRequest"}, - "output":{"shape":"ListTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ValidationException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

" - }, - "ListTables":{ - "name":"ListTables", - "http":{ - "method":"GET", - "requestUri":"/workbooks/{workbookId}/tables" - }, - "input":{"shape":"ListTablesRequest"}, - "output":{"shape":"ListTablesResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The ListTables API allows you to retrieve a list of all the tables in a workbook.

" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The ListTagsForResource API allows you to return a resource's tags.

" - }, - "QueryTableRows":{ - "name":"QueryTableRows", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/query" - }, - "input":{"shape":"QueryTableRowsRequest"}, - "output":{"shape":"QueryTableRowsResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

" - }, - "StartTableDataImportJob":{ - "name":"StartTableDataImportJob", - "http":{ - "method":"POST", - "requestUri":"/workbooks/{workbookId}/tables/{tableId}/import" - }, - "input":{"shape":"StartTableDataImportJobRequest"}, - "output":{"shape":"StartTableDataImportJobResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"

The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.

" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResult"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"RequestTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"}, - {"shape":"ValidationException"} - ], - "documentation":"

The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

", - "error":{"httpStatusCode":403}, - "exception":true - }, - "AutomationExecutionException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

The automation execution did not end successfully.

", - "error":{"httpStatusCode":400}, - "exception":true - }, - "AutomationExecutionTimeoutException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

The automation execution timed out.

", - "error":{ - "httpStatusCode":504, - "senderFault":true - }, - "exception":true - }, - "AwsUserArn":{ - "type":"string", - "max":2048, - "min":20 - }, - "BatchCreateTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "rowsToCreate" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook where the new rows are being added.

If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table where the new rows are being added.

If a table with the specified ID could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "rowsToCreate":{ - "shape":"CreateRowDataList", - "documentation":"

The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "BatchCreateTableRowsResult":{ - "type":"structure", - "required":[ - "workbookCursor", - "createdRows" - ], - "members":{ - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

The updated workbook cursor after adding the new rows at the end of the table.

" - }, - "createdRows":{ - "shape":"CreatedRowsMap", - "documentation":"

The map of batch item id to the row id that was created for that item.

" - }, - "failedBatchItems":{ - "shape":"FailedBatchItems", - "documentation":"

The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.

" - } - } - }, - "BatchDeleteTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "rowIds" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook where the rows are being deleted.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table where the rows are being deleted.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "rowIds":{ - "shape":"RowIdList", - "documentation":"

The list of row ids to delete from the table. You need to specify at least one row id in this list.

Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the delete action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "BatchDeleteTableRowsResult":{ - "type":"structure", - "required":["workbookCursor"], - "members":{ - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

The updated workbook cursor after deleting the rows from the table.

" - }, - "failedBatchItems":{ - "shape":"FailedBatchItems", - "documentation":"

The list of row ids in the request that could not be deleted from the table. Each element in this list contains one row id from the request that could not be deleted along with the reason why that item could not be deleted.

" - } - } - }, - "BatchErrorMessage":{ - "type":"string", - "pattern":"^(?!\\s*$).+" - }, - "BatchItemId":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^(?!\\s*$).+" - }, - "BatchUpdateTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "rowsToUpdate" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook where the rows are being updated.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table where the rows are being updated.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "rowsToUpdate":{ - "shape":"UpdateRowDataList", - "documentation":"

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "BatchUpdateTableRowsResult":{ - "type":"structure", - "required":["workbookCursor"], - "members":{ - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

The updated workbook cursor after adding the new rows at the end of the table.

" - }, - "failedBatchItems":{ - "shape":"FailedBatchItems", - "documentation":"

The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.

" - } - } - }, - "BatchUpsertTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "rowsToUpsert" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook where the rows are being upserted.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table where the rows are being upserted.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "rowsToUpsert":{ - "shape":"UpsertRowDataList", - "documentation":"

The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "BatchUpsertTableRowsResult":{ - "type":"structure", - "required":[ - "rows", - "workbookCursor" - ], - "members":{ - "rows":{ - "shape":"UpsertRowsResultMap", - "documentation":"

A map with the batch item id as the key and the result of the upsert operation as the value. The result of the upsert operation specifies whether existing rows were updated or a new row was appended, along with the list of row ids that were affected.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

The updated workbook cursor after updating or appending rows in the table.

" - }, - "failedBatchItems":{ - "shape":"FailedBatchItems", - "documentation":"

The list of batch items in the request that could not be updated or appended in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated or appended.

" - } - } - }, - "Cell":{ - "type":"structure", - "members":{ - "formula":{ - "shape":"Formula", - "documentation":"

The formula contained in the cell. This field is empty if a cell does not have a formula.

" - }, - "format":{ - "shape":"Format", - "documentation":"

The format of the cell. If this field is empty, then the format is either not specified in the workbook or the format is set to AUTO.

" - }, - "rawValue":{ - "shape":"RawValue", - "documentation":"

The raw value of the data contained in the cell. The raw value depends on the format of the data in the cell. However the attribute in the API return value is always a string containing the raw value.

Cells with format DATE, DATE_TIME or TIME have the raw value as a floating point number where the whole number represents the number of days since 1/1/1900 and the fractional part represents the fraction of the day since midnight. For example, a cell with date 11/3/2020 has the raw value \"44138\". A cell with the time 9:00 AM has the raw value \"0.375\" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value \"44138.375\". Notice that even though the raw value is a number in all three cases, it is still represented as a string.

Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw value of the data as the number representing the data being displayed. For example, the number 1.325 with two decimal places in the format will have it's raw value as \"1.325\" and formatted value as \"1.33\". A currency value for $10 will have the raw value as \"10\" and formatted value as \"$10.00\". A value representing 20% with two decimal places in the format will have its raw value as \"0.2\" and the formatted value as \"20.00%\". An accounting value of -$25 will have \"-25\" as the raw value and \"$ (25.00)\" as the formatted value.

Cells with format TEXT will have the raw text as the raw value. For example, a cell with text \"John Smith\" will have \"John Smith\" as both the raw value and the formatted value.

Cells with format CONTACT will have the name of the contact as a formatted value and the email address of the contact as the raw value. For example, a contact for John Smith will have \"John Smith\" as the formatted value and \"john.smith@example.com\" as the raw value.

Cells with format ROWLINK (aka picklist) will have the first column of the linked row as the formatted value and the row id of the linked row as the raw value. For example, a cell containing a picklist to a table that displays task status might have \"Completed\" as the formatted value and \"row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03\" as the raw value.

Cells with format ROWSET (aka multi-select or multi-record picklist) will by default have the first column of each of the linked rows as the formatted value in the list, and the rowset id of the linked rows as the raw value. For example, a cell containing a multi-select picklist to a table that contains items might have \"Item A\", \"Item B\" in the formatted value list and \"rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/ [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]\" as the raw value.

Cells with format ATTACHMENT will have the name of the attachment as the formatted value and the attachment id as the raw value. For example, a cell containing an attachment named \"image.jpeg\" will have \"image.jpeg\" as the formatted value and \"attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03\" as the raw value.

Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no auto-detected format, the raw and formatted values will be the same as the data in the cell.

" - }, - "formattedValue":{ - "shape":"FormattedValue", - "documentation":"

The formatted value of the cell. This is the value that you see displayed in the cell in the UI.

Note that the formatted value of a cell is always represented as a string irrespective of the data that is stored in the cell. For example, if a cell contains a date, the formatted value of the cell is the string representation of the formatted date being shown in the cell in the UI. See details in the rawValue field below for how cells of different formats will have different raw and formatted values.

" - }, - "formattedValues":{ - "shape":"FormattedValuesList", - "documentation":"

A list of formatted values of the cell. This field is only returned when the cell is ROWSET format (aka multi-select or multi-record picklist). Values in the list are always represented as strings. The formattedValue field will be empty if this field is returned.

" - } - }, - "documentation":"

An object that represents a single cell in a table.

", - "sensitive":true - }, - "CellInput":{ - "type":"structure", - "members":{ - "fact":{ - "shape":"Fact", - "documentation":"

Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.

" - }, - "facts":{ - "shape":"FactList", - "documentation":"

A list representing the values that are entered into a ROWSET cell. Facts list can have either only values or rowIDs, and rowIDs should from the same table.

" - } - }, - "documentation":"

CellInput object contains the data needed to create or update cells in a table.

CellInput object has only a facts field or a fact field, but not both. A 400 bad request will be thrown if both fact and facts field are present.

" - }, - "Cells":{ - "type":"list", - "member":{"shape":"Cell"} - }, - "ClientRequestToken":{ - "type":"string", - "max":64, - "min":32, - "pattern":"^(?!\\s*$).+" - }, - "ColumnMetadata":{ - "type":"structure", - "required":[ - "name", - "format" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the column.

" - }, - "format":{ - "shape":"Format", - "documentation":"

The format of the column.

" - } - }, - "documentation":"

Metadata for column in the table.

" - }, - "CreateRowData":{ - "type":"structure", - "required":[ - "batchItemId", - "cellsToCreate" - ], - "members":{ - "batchItemId":{ - "shape":"BatchItemId", - "documentation":"

An external identifier that represents the single row that is being created as part of the BatchCreateTableRows request. This can be any string that you can use to identify the row in the request. The BatchCreateTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

" - }, - "cellsToCreate":{ - "shape":"RowDataInput", - "documentation":"

A map representing the cells to create in the new row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" - } - }, - "documentation":"

Data needed to create a single row in a table as part of the BatchCreateTableRows request.

" - }, - "CreateRowDataList":{ - "type":"list", - "member":{"shape":"CreateRowData"}, - "max":100, - "min":1 - }, - "CreatedRowsMap":{ - "type":"map", - "key":{"shape":"BatchItemId"}, - "value":{"shape":"RowId"} - }, - "DataItem":{ - "type":"structure", - "members":{ - "overrideFormat":{ - "shape":"Format", - "documentation":"

The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table.

" - }, - "rawValue":{ - "shape":"RawValue", - "documentation":"

The raw value of the data. e.g. jsmith@example.com

" - }, - "formattedValue":{ - "shape":"FormattedValue", - "documentation":"

The formatted value of the data. e.g. John Smith.

" - } - }, - "documentation":"

The data in a particular data cell defined on the screen.

", - "sensitive":true - }, - "DataItems":{ - "type":"list", - "member":{"shape":"DataItem"} - }, - "DelimitedTextDelimiter":{ - "type":"string", - "max":1, - "min":1, - "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]?$" - }, - "DelimitedTextImportOptions":{ - "type":"structure", - "required":["delimiter"], - "members":{ - "delimiter":{ - "shape":"DelimitedTextDelimiter", - "documentation":"

The delimiter to use for separating columns in a single row of the input.

" - }, - "hasHeaderRow":{ - "shape":"HasHeaderRow", - "documentation":"

Indicates whether the input file has a header row at the top containing the column names.

" - }, - "ignoreEmptyRows":{ - "shape":"IgnoreEmptyRows", - "documentation":"

A parameter to indicate whether empty rows should be ignored or be included in the import.

" - }, - "dataCharacterEncoding":{ - "shape":"ImportDataCharacterEncoding", - "documentation":"

The encoding of the data in the input file.

" - } - }, - "documentation":"

An object that contains the options relating to parsing delimited text as part of an import request.

" - }, - "DescribeTableDataImportJobRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "jobId" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook into which data was imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table into which data was imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "jobId":{ - "shape":"JobId", - "documentation":"

The ID of the job that was returned by the StartTableDataImportJob request.

If a job with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"jobId" - } - } - }, - "DescribeTableDataImportJobResult":{ - "type":"structure", - "required":[ - "jobStatus", - "message", - "jobMetadata" - ], - "members":{ - "jobStatus":{ - "shape":"TableDataImportJobStatus", - "documentation":"

The current status of the import job.

" - }, - "message":{ - "shape":"TableDataImportJobMessage", - "documentation":"

A message providing more details about the current status of the import job.

" - }, - "jobMetadata":{ - "shape":"TableDataImportJobMetadata", - "documentation":"

The metadata about the job that was submitted for import.

" - }, - "errorCode":{ - "shape":"ErrorCode", - "documentation":"

If job status is failed, error code to understand reason for the failure.

" - } - } - }, - "DestinationOptions":{ - "type":"structure", - "members":{ - "columnMap":{ - "shape":"ImportColumnMap", - "documentation":"

A map of the column id to the import properties for each column.

" - } - }, - "documentation":"

An object that contains the options relating to the destination of the import request.

" - }, - "Email":{ - "type":"string", - "max":254, - "min":3, - "pattern":"^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$", - "sensitive":true - }, - "ErrorCode":{ - "type":"string", - "enum":[ - "ACCESS_DENIED", - "INVALID_URL_ERROR", - "INVALID_IMPORT_OPTIONS_ERROR", - "INVALID_TABLE_ID_ERROR", - "INVALID_TABLE_COLUMN_ID_ERROR", - "TABLE_NOT_FOUND_ERROR", - "FILE_EMPTY_ERROR", - "INVALID_FILE_TYPE_ERROR", - "FILE_PARSING_ERROR", - "FILE_SIZE_LIMIT_ERROR", - "FILE_NOT_FOUND_ERROR", - "UNKNOWN_ERROR", - "RESOURCE_NOT_FOUND_ERROR", - "SYSTEM_LIMIT_ERROR" - ] - }, - "ErrorMessage":{"type":"string"}, - "Fact":{ - "type":"string", - "max":8192, - "min":0, - "pattern":"[\\s\\S]*", - "sensitive":true - }, - "FactList":{ - "type":"list", - "member":{"shape":"Fact"}, - "max":220, - "min":0 - }, - "FailedBatchItem":{ - "type":"structure", - "required":[ - "id", - "errorMessage" - ], - "members":{ - "id":{ - "shape":"BatchItemId", - "documentation":"

The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

" - }, - "errorMessage":{ - "shape":"BatchErrorMessage", - "documentation":"

The error message that indicates why the batch item failed.

" - } - }, - "documentation":"

A single item in a batch that failed to perform the intended action because of an error preventing it from succeeding.

" - }, - "FailedBatchItems":{ - "type":"list", - "member":{"shape":"FailedBatchItem"}, - "max":100, - "min":0 - }, - "Filter":{ - "type":"structure", - "required":["formula"], - "members":{ - "formula":{ - "shape":"Formula", - "documentation":"

A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.

" - }, - "contextRowId":{ - "shape":"RowId", - "documentation":"

The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.

" - } - }, - "documentation":"

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

" - }, - "Format":{ - "type":"string", - "enum":[ - "AUTO", - "NUMBER", - "CURRENCY", - "DATE", - "TIME", - "DATE_TIME", - "PERCENTAGE", - "TEXT", - "ACCOUNTING", - "CONTACT", - "ROWLINK", - "ROWSET" - ] - }, - "FormattedValue":{ - "type":"string", - "max":8192, - "min":0, - "pattern":"[\\s\\S]*" - }, - "FormattedValuesList":{ - "type":"list", - "member":{"shape":"FormattedValue"}, - "max":220, - "min":0 - }, - "Formula":{ - "type":"string", - "max":8192, - "min":0, - "pattern":"^=.*", - "sensitive":true - }, - "GetScreenDataRequest":{ - "type":"structure", - "required":[ - "workbookId", - "appId", - "screenId" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook that contains the screen.

" - }, - "appId":{ - "shape":"ResourceId", - "documentation":"

The ID of the app that contains the screen.

" - }, - "screenId":{ - "shape":"ResourceId", - "documentation":"

The ID of the screen.

" - }, - "variables":{ - "shape":"VariableValueMap", - "documentation":"

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" - } - } - }, - "GetScreenDataResult":{ - "type":"structure", - "required":[ - "results", - "workbookCursor" - ], - "members":{ - "results":{ - "shape":"ResultSetMap", - "documentation":"

A map of all the rows on the screen keyed by block name.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.

" - } - } - }, - "HasHeaderRow":{"type":"boolean"}, - "IgnoreEmptyRows":{"type":"boolean"}, - "ImportColumnMap":{ - "type":"map", - "key":{"shape":"ResourceId"}, - "value":{"shape":"SourceDataColumnProperties"}, - "max":100 - }, - "ImportDataCharacterEncoding":{ - "type":"string", - "enum":[ - "UTF-8", - "US-ASCII", - "ISO-8859-1", - "UTF-16BE", - "UTF-16LE", - "UTF-16" - ] - }, - "ImportDataSource":{ - "type":"structure", - "required":["dataSourceConfig"], - "members":{ - "dataSourceConfig":{ - "shape":"ImportDataSourceConfig", - "documentation":"

The configuration parameters for the data source of the import

" - } - }, - "documentation":"

An object that has details about the source of the data that was submitted for import.

" - }, - "ImportDataSourceConfig":{ - "type":"structure", - "members":{ - "dataSourceUrl":{ - "shape":"SecureURL", - "documentation":"

The URL from which source data will be downloaded for the import request.

" - } - }, - "documentation":"

An object that contains the configuration parameters for the data source of an import request.

" - }, - "ImportJobSubmitter":{ - "type":"structure", - "members":{ - "email":{ - "shape":"Email", - "documentation":"

The email id of the submitter of the import job, if available.

" - }, - "userArn":{ - "shape":"AwsUserArn", - "documentation":"

The AWS user ARN of the submitter of the import job, if available.

" - } - }, - "documentation":"

An object that contains the attributes of the submitter of the import job.

" - }, - "ImportOptions":{ - "type":"structure", - "members":{ - "destinationOptions":{ - "shape":"DestinationOptions", - "documentation":"

Options relating to the destination of the import request.

" - }, - "delimitedTextOptions":{ - "shape":"DelimitedTextImportOptions", - "documentation":"

Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.

" - } - }, - "documentation":"

An object that contains the options specified by the sumitter of the import request.

" - }, - "ImportSourceDataFormat":{ - "type":"string", - "enum":["DELIMITED_TEXT"] - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

There were unexpected errors from the server.

", - "error":{"httpStatusCode":500}, - "exception":true - }, - "InvokeScreenAutomationRequest":{ - "type":"structure", - "required":[ - "workbookId", - "appId", - "screenId", - "screenAutomationId" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook that contains the screen automation.

", - "location":"uri", - "locationName":"workbookId" - }, - "appId":{ - "shape":"ResourceId", - "documentation":"

The ID of the app that contains the screen automation.

", - "location":"uri", - "locationName":"appId" - }, - "screenId":{ - "shape":"ResourceId", - "documentation":"

The ID of the screen that contains the screen automation.

", - "location":"uri", - "locationName":"screenId" - }, - "screenAutomationId":{ - "shape":"ResourceId", - "documentation":"

The ID of the automation action to be performed.

", - "location":"uri", - "locationName":"automationId" - }, - "variables":{ - "shape":"VariableValueMap", - "documentation":"

Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

" - }, - "rowId":{ - "shape":"RowId", - "documentation":"

The row ID for the automation if the automation is defined inside a block with source or list.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "InvokeScreenAutomationResult":{ - "type":"structure", - "required":["workbookCursor"], - "members":{ - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

The updated workbook cursor after performing the automation action.

" - } - } - }, - "JobId":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" - }, - "ListTableColumnsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook that contains the table whose columns are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table whose columns are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListTableColumnsResult":{ - "type":"structure", - "required":["tableColumns"], - "members":{ - "tableColumns":{ - "shape":"TableColumns", - "documentation":"

The list of columns in the table.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" - } - } - }, - "ListTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook that contains the table whose rows are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table whose rows are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "rowIds":{ - "shape":"RowIdList", - "documentation":"

This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of rows to return in each page of the results.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" - } - } - }, - "ListTableRowsResult":{ - "type":"structure", - "required":[ - "columnIds", - "rows", - "workbookCursor" - ], - "members":{ - "columnIds":{ - "shape":"ResourceIds", - "documentation":"

The list of columns in the table whose row data is returned in the result.

" - }, - "rows":{ - "shape":"TableRows", - "documentation":"

The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.

" - }, - "rowIdsNotFound":{ - "shape":"RowIdList", - "documentation":"

The list of row ids included in the request that were not found in the table.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" - } - } - }, - "ListTablesRequest":{ - "type":"structure", - "required":["workbookId"], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook whose tables are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of tables to return in each page of the results.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListTablesResult":{ - "type":"structure", - "required":["tables"], - "members":{ - "tables":{ - "shape":"Tables", - "documentation":"

The list of tables in the workbook.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The resource's Amazon Resource Name (ARN).

", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResult":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagsMap", - "documentation":"

The resource's tags.

" - } - } - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "Name":{ - "type":"string", - "sensitive":true - }, - "PaginationToken":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^(?!\\s*$).+" - }, - "QueryTableRowsRequest":{ - "type":"structure", - "required":[ - "workbookId", - "tableId", - "filterFormula" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook whose table rows are being queried.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "tableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table whose rows are being queried.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "filterFormula":{ - "shape":"Filter", - "documentation":"

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of rows to return in each page of the results.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" - } - } - }, - "QueryTableRowsResult":{ - "type":"structure", - "required":[ - "columnIds", - "rows", - "workbookCursor" - ], - "members":{ - "columnIds":{ - "shape":"ResourceIds", - "documentation":"

The list of columns in the table whose row data is returned in the result.

" - }, - "rows":{ - "shape":"TableRows", - "documentation":"

The list of rows in the table that match the query filter.

" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" - }, - "workbookCursor":{ - "shape":"WorkbookCursor", - "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" - } - } - }, - "RawValue":{ - "type":"string", - "max":32767, - "min":0, - "pattern":"[\\s\\S]*" - }, - "RequestTimeoutException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

The request timed out.

", - "error":{ - "httpStatusCode":504, - "senderFault":true - }, - "exception":true - }, - "ResourceArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^arn:aws:honeycode:.+:[0-9]{12}:.+:.+$" - }, - "ResourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" - }, - "ResourceIds":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":100, - "min":1 - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

", - "error":{"httpStatusCode":404}, - "exception":true - }, - "ResultHeader":{ - "type":"list", - "member":{"shape":"ColumnMetadata"} - }, - "ResultRow":{ - "type":"structure", - "required":["dataItems"], - "members":{ - "rowId":{ - "shape":"RowId", - "documentation":"

The ID for a particular row.

" - }, - "dataItems":{ - "shape":"DataItems", - "documentation":"

List of all the data cells in a row.

" - } - }, - "documentation":"

A single row in the ResultSet.

" - }, - "ResultRows":{ - "type":"list", - "member":{"shape":"ResultRow"} - }, - "ResultSet":{ - "type":"structure", - "required":[ - "headers", - "rows" - ], - "members":{ - "headers":{ - "shape":"ResultHeader", - "documentation":"

List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

For example, a task list that displays the task name, due date and assigned person might have headers [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

" - }, - "rows":{ - "shape":"ResultRows", - "documentation":"

List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

" - } - }, - "documentation":"

ResultSet contains the results of the request for a single block or list defined on the screen.

" - }, - "ResultSetMap":{ - "type":"map", - "key":{"shape":"Name"}, - "value":{"shape":"ResultSet"} - }, - "RowDataInput":{ - "type":"map", - "key":{"shape":"ResourceId"}, - "value":{"shape":"CellInput"}, - "max":100, - "min":1 - }, - "RowId":{ - "type":"string", - "max":77, - "min":77, - "pattern":"row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" - }, - "RowIdList":{ - "type":"list", - "member":{"shape":"RowId"}, - "max":100, - "min":1 - }, - "SecureURL":{ - "type":"string", - "max":8000, - "min":1, - "pattern":"^https:\\/\\/[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$", - "sensitive":true - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

The request caused service quota to be breached.

", - "error":{"httpStatusCode":402}, - "exception":true - }, - "ServiceUnavailableException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

Remote service is unreachable.

", - "error":{"httpStatusCode":503}, - "exception":true - }, - "SourceDataColumnIndex":{ - "type":"integer", - "min":1 - }, - "SourceDataColumnProperties":{ - "type":"structure", - "members":{ - "columnIndex":{ - "shape":"SourceDataColumnIndex", - "documentation":"

The index of the column in the input file.

" - } - }, - "documentation":"

An object that contains the properties for importing data to a specific column in a table.

" - }, - "StartTableDataImportJobRequest":{ - "type":"structure", - "required":[ - "workbookId", - "dataSource", - "dataFormat", - "destinationTableId", - "importOptions", - "clientRequestToken" - ], - "members":{ - "workbookId":{ - "shape":"ResourceId", - "documentation":"

The ID of the workbook where the rows are being imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"workbookId" - }, - "dataSource":{ - "shape":"ImportDataSource", - "documentation":"

The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

" - }, - "dataFormat":{ - "shape":"ImportSourceDataFormat", - "documentation":"

The format of the data that is being imported. Currently the only option supported is \"DELIMITED_TEXT\".

" - }, - "destinationTableId":{ - "shape":"ResourceId", - "documentation":"

The ID of the table where the rows are being imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", - "location":"uri", - "locationName":"tableId" - }, - "importOptions":{ - "shape":"ImportOptions", - "documentation":"

The options for customizing this import request.

" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" - } - } - }, - "StartTableDataImportJobResult":{ - "type":"structure", - "required":[ - "jobId", - "jobStatus" - ], - "members":{ - "jobId":{ - "shape":"JobId", - "documentation":"

The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.

" - }, - "jobStatus":{ - "shape":"TableDataImportJobStatus", - "documentation":"

The status of the import job immediately after submitting the request.

" - } - } - }, - "Table":{ - "type":"structure", - "members":{ - "tableId":{ - "shape":"ResourceId", - "documentation":"

The id of the table.

" - }, - "tableName":{ - "shape":"TableName", - "documentation":"

The name of the table.

" - } - }, - "documentation":"

An object representing the properties of a table in a workbook.

" - }, - "TableColumn":{ - "type":"structure", - "members":{ - "tableColumnId":{ - "shape":"ResourceId", - "documentation":"

The id of the column in the table.

" - }, - "tableColumnName":{ - "shape":"TableColumnName", - "documentation":"

The name of the column in the table.

" - }, - "format":{ - "shape":"Format", - "documentation":"

The column level format that is applied in the table. An empty value in this field means that the column format is the default value 'AUTO'.

" - } - }, - "documentation":"

An object that contains attributes about a single column in a table

" - }, - "TableColumnName":{"type":"string"}, - "TableColumns":{ - "type":"list", - "member":{"shape":"TableColumn"} - }, - "TableDataImportJobMessage":{"type":"string"}, - "TableDataImportJobMetadata":{ - "type":"structure", - "required":[ - "submitter", - "submitTime", - "importOptions", - "dataSource" - ], - "members":{ - "submitter":{ - "shape":"ImportJobSubmitter", - "documentation":"

Details about the submitter of the import request.

" - }, - "submitTime":{ - "shape":"TimestampInMillis", - "documentation":"

The timestamp when the job was submitted for import.

" - }, - "importOptions":{ - "shape":"ImportOptions", - "documentation":"

The options that was specified at the time of submitting the import request.

" - }, - "dataSource":{ - "shape":"ImportDataSource", - "documentation":"

The source of the data that was submitted for import.

" - } - }, - "documentation":"

The metadata associated with the table data import job that was submitted.

" - }, - "TableDataImportJobStatus":{ - "type":"string", - "enum":[ - "SUBMITTED", - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "TableName":{"type":"string"}, - "TableRow":{ - "type":"structure", - "required":[ - "rowId", - "cells" - ], - "members":{ - "rowId":{ - "shape":"RowId", - "documentation":"

The id of the row in the table.

" - }, - "cells":{ - "shape":"Cells", - "documentation":"

A list of cells in the table row. The cells appear in the same order as the columns of the table.

" - } - }, - "documentation":"

An object that contains attributes about a single row in a table

" - }, - "TableRows":{ - "type":"list", - "member":{"shape":"TableRow"} - }, - "Tables":{ - "type":"list", - "member":{"shape":"Table"} - }, - "TagKey":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" - }, - "TagKeysList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "documentation":"

A list of tag keys

", - "max":100 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The resource's Amazon Resource Name (ARN).

", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A list of tags to apply to the resource.

" - } - } - }, - "TagResourceResult":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" - }, - "TagsMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "documentation":"

A string to string map representing tags

", - "max":100 - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

Tps(transactions per second) rate reached.

", - "error":{"httpStatusCode":429}, - "exception":true - }, - "TimestampInMillis":{"type":"timestamp"}, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The resource's Amazon Resource Name (ARN).

", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeysList", - "documentation":"

A list of tag keys to remove from the resource.

", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResult":{ - "type":"structure", - "members":{ - } - }, - "UpdateRowData":{ - "type":"structure", - "required":[ - "rowId", - "cellsToUpdate" - ], - "members":{ - "rowId":{ - "shape":"RowId", - "documentation":"

The id of the row that needs to be updated.

" - }, - "cellsToUpdate":{ - "shape":"RowDataInput", - "documentation":"

A map representing the cells to update in the given row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" - } - }, - "documentation":"

Data needed to create a single row in a table as part of the BatchCreateTableRows request.

" - }, - "UpdateRowDataList":{ - "type":"list", - "member":{"shape":"UpdateRowData"}, - "max":100, - "min":1 - }, - "UpsertAction":{ - "type":"string", - "enum":[ - "UPDATED", - "APPENDED" - ] - }, - "UpsertRowData":{ - "type":"structure", - "required":[ - "batchItemId", - "filter", - "cellsToUpdate" - ], - "members":{ - "batchItemId":{ - "shape":"BatchItemId", - "documentation":"

An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

" - }, - "filter":{ - "shape":"Filter", - "documentation":"

The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

" - }, - "cellsToUpdate":{ - "shape":"RowDataInput", - "documentation":"

A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" - } - }, - "documentation":"

Data needed to upsert rows in a table as part of a single item in the BatchUpsertTableRows request.

" - }, - "UpsertRowDataList":{ - "type":"list", - "member":{"shape":"UpsertRowData"} - }, - "UpsertRowsResult":{ - "type":"structure", - "required":[ - "rowIds", - "upsertAction" - ], - "members":{ - "rowIds":{ - "shape":"RowIdList", - "documentation":"

The list of row ids that were changed as part of an upsert row operation. If the upsert resulted in an update, this list could potentially contain multiple rows that matched the filter and hence got updated. If the upsert resulted in an append, this list would only have the single row that was appended.

" - }, - "upsertAction":{ - "shape":"UpsertAction", - "documentation":"

The result of the upsert action.

" - } - }, - "documentation":"

An object that represents the result of a single upsert row request.

" - }, - "UpsertRowsResultMap":{ - "type":"map", - "key":{"shape":"BatchItemId"}, - "value":{"shape":"UpsertRowsResult"} - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "documentation":"

Request is invalid. The message in the response contains details on why the request is invalid.

", - "error":{"httpStatusCode":400}, - "exception":true - }, - "VariableName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^(?!\\s*$).+", - "sensitive":true - }, - "VariableValue":{ - "type":"structure", - "required":["rawValue"], - "members":{ - "rawValue":{ - "shape":"RawValue", - "documentation":"

Raw value of the variable.

" - } - }, - "documentation":"

The input variables to the app to be used by the InvokeScreenAutomation action request.

", - "sensitive":true - }, - "VariableValueMap":{ - "type":"map", - "key":{"shape":"VariableName"}, - "value":{"shape":"VariableValue"}, - "sensitive":true - }, - "WorkbookCursor":{"type":"long"} - }, - "documentation":"

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

" -} diff --git a/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json b/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json deleted file mode 100644 index bfec834a71..0000000000 --- a/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json +++ /dev/null @@ -1,327 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://honeycode.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file From 864f4318b5e07c765bda2bf9f6fab62f07655aa3 Mon Sep 17 00:00:00 2001 From: Nate Prewitt Date: Fri, 24 May 2024 10:04:34 -0700 Subject: [PATCH 2/7] Remove alexaforbusiness client following the service deprecation (#3187) --- .../api-change-alexaforbusiness-18876.json | 5 + .../2017-11-09/endpoint-rule-set-1.json | 314 - .../2017-11-09/examples-1.json | 5 - .../2017-11-09/paginators-1.json | 82 - .../2017-11-09/service-2.json | 6318 ----------------- botocore/data/endpoints.json | 5 - botocore/utils.py | 3 - .../alexaforbusiness/endpoint-tests-1.json | 314 - tests/functional/models/endpoints.json | 5 - tests/functional/test_event_alias.py | 4 - tests/functional/test_paginator_config.py | 5 - 11 files changed, 5 insertions(+), 7055 deletions(-) create mode 100644 .changes/next-release/api-change-alexaforbusiness-18876.json delete mode 100644 botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json delete mode 100644 botocore/data/alexaforbusiness/2017-11-09/examples-1.json delete mode 100644 botocore/data/alexaforbusiness/2017-11-09/paginators-1.json delete mode 100644 botocore/data/alexaforbusiness/2017-11-09/service-2.json delete mode 100644 tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json diff --git a/.changes/next-release/api-change-alexaforbusiness-18876.json b/.changes/next-release/api-change-alexaforbusiness-18876.json new file mode 100644 index 0000000000..b6b8cdbe60 --- /dev/null +++ b/.changes/next-release/api-change-alexaforbusiness-18876.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``alexaforbusiness``", + "description": "The alexaforbusiness client has been removed following the deprecation of the service." +} diff --git a/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json b/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json deleted file mode 100644 index d8065b9dc0..0000000000 --- a/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "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": [ - { - "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": [ - { - "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": [], - "endpoint": { - "url": "https://a4b-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": [], - "endpoint": { - "url": "https://a4b-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": [], - "endpoint": { - "url": "https://a4b.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://a4b.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/botocore/data/alexaforbusiness/2017-11-09/examples-1.json b/botocore/data/alexaforbusiness/2017-11-09/examples-1.json deleted file mode 100644 index 0ea7e3b0bb..0000000000 --- a/botocore/data/alexaforbusiness/2017-11-09/examples-1.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": "1.0", - "examples": { - } -} diff --git a/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json b/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json deleted file mode 100644 index ced5de2f7e..0000000000 --- a/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "pagination": { - "ListSkills": { - "result_key": "SkillSummaries", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "SearchUsers": { - "result_key": "Users", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "ListTags": { - "result_key": "Tags", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "SearchProfiles": { - "result_key": "Profiles", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "SearchSkillGroups": { - "result_key": "SkillGroups", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "SearchDevices": { - "result_key": "Devices", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "SearchRooms": { - "result_key": "Rooms", - "output_token": "NextToken", - "input_token": "NextToken", - "limit_key": "MaxResults" - }, - "ListBusinessReportSchedules": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "BusinessReportSchedules" - }, - "ListConferenceProviders": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "ConferenceProviders" - }, - "ListDeviceEvents": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "DeviceEvents" - }, - "ListSkillsStoreCategories": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "CategoryList" - }, - "ListSkillsStoreSkillsByCategory": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "SkillsStoreSkills" - }, - "ListSmartHomeAppliances": { - "input_token": "NextToken", - "limit_key": "MaxResults", - "output_token": "NextToken", - "result_key": "SmartHomeAppliances" - } - } -} diff --git a/botocore/data/alexaforbusiness/2017-11-09/service-2.json b/botocore/data/alexaforbusiness/2017-11-09/service-2.json deleted file mode 100644 index 9aa7a8702d..0000000000 --- a/botocore/data/alexaforbusiness/2017-11-09/service-2.json +++ /dev/null @@ -1,6318 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2017-11-09", - "endpointPrefix":"a4b", - "jsonVersion":"1.1", - "protocol":"json", - "serviceFullName":"Alexa For Business", - "serviceId":"Alexa For Business", - "signatureVersion":"v4", - "targetPrefix":"AlexaForBusiness", - "uid":"alexaforbusiness-2017-11-09" - }, - "operations":{ - "ApproveSkill":{ - "name":"ApproveSkill", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ApproveSkillRequest"}, - "output":{"shape":"ApproveSkillResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateContactWithAddressBook":{ - "name":"AssociateContactWithAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateContactWithAddressBookRequest"}, - "output":{"shape":"AssociateContactWithAddressBookResponse"}, - "errors":[ - {"shape":"LimitExceededException"} - ], - "documentation":"

Associates a contact with a given address book.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateDeviceWithNetworkProfile":{ - "name":"AssociateDeviceWithNetworkProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDeviceWithNetworkProfileRequest"}, - "output":{"shape":"AssociateDeviceWithNetworkProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"DeviceNotRegisteredException"} - ], - "documentation":"

Associates a device with the specified network profile.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateDeviceWithRoom":{ - "name":"AssociateDeviceWithRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDeviceWithRoomRequest"}, - "output":{"shape":"AssociateDeviceWithRoomResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"DeviceNotRegisteredException"} - ], - "documentation":"

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateSkillGroupWithRoom":{ - "name":"AssociateSkillGroupWithRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateSkillGroupWithRoomRequest"}, - "output":{"shape":"AssociateSkillGroupWithRoomResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateSkillWithSkillGroup":{ - "name":"AssociateSkillWithSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateSkillWithSkillGroupRequest"}, - "output":{"shape":"AssociateSkillWithSkillGroupResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"}, - {"shape":"SkillNotLinkedException"} - ], - "documentation":"

Associates a skill with a skill group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "AssociateSkillWithUsers":{ - "name":"AssociateSkillWithUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateSkillWithUsersRequest"}, - "output":{"shape":"AssociateSkillWithUsersResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} - ], - "documentation":"

Makes a private skill available for enrolled users to enable on their devices.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateAddressBook":{ - "name":"CreateAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAddressBookRequest"}, - "output":{"shape":"CreateAddressBookResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"

Creates an address book with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateBusinessReportSchedule":{ - "name":"CreateBusinessReportSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateBusinessReportScheduleRequest"}, - "output":{"shape":"CreateBusinessReportScheduleResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"} - ], - "documentation":"

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateConferenceProvider":{ - "name":"CreateConferenceProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateConferenceProviderRequest"}, - "output":{"shape":"CreateConferenceProviderResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"} - ], - "documentation":"

Adds a new conference provider under the user's AWS account.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateContact":{ - "name":"CreateContact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateContactRequest"}, - "output":{"shape":"CreateContactResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"

Creates a contact with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateGatewayGroup":{ - "name":"CreateGatewayGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGatewayGroupRequest"}, - "output":{"shape":"CreateGatewayGroupResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"

Creates a gateway group with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateNetworkProfile":{ - "name":"CreateNetworkProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkProfileRequest"}, - "output":{"shape":"CreateNetworkProfileResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidCertificateAuthorityException"}, - {"shape":"InvalidServiceLinkedRoleStateException"} - ], - "documentation":"

Creates a network profile with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateProfile":{ - "name":"CreateProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProfileRequest"}, - "output":{"shape":"CreateProfileResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"AlreadyExistsException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Creates a new room profile with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateRoom":{ - "name":"CreateRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRoomRequest"}, - "output":{"shape":"CreateRoomResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"

Creates a room with the specified details.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateSkillGroup":{ - "name":"CreateSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSkillGroupRequest"}, - "output":{"shape":"CreateSkillGroupResponse"}, - "errors":[ - {"shape":"AlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Creates a skill group with a specified name and description.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "CreateUser":{ - "name":"CreateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserRequest"}, - "output":{"shape":"CreateUserResponse"}, - "errors":[ - {"shape":"ResourceInUseException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Creates a user.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteAddressBook":{ - "name":"DeleteAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAddressBookRequest"}, - "output":{"shape":"DeleteAddressBookResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes an address book by the address book ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteBusinessReportSchedule":{ - "name":"DeleteBusinessReportSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteBusinessReportScheduleRequest"}, - "output":{"shape":"DeleteBusinessReportScheduleResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes the recurring report delivery schedule with the specified schedule ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteConferenceProvider":{ - "name":"DeleteConferenceProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteConferenceProviderRequest"}, - "output":{"shape":"DeleteConferenceProviderResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Deletes a conference provider.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteContact":{ - "name":"DeleteContact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteContactRequest"}, - "output":{"shape":"DeleteContactResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a contact by the contact ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteDevice":{ - "name":"DeleteDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDeviceRequest"}, - "output":{"shape":"DeleteDeviceResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidCertificateAuthorityException"} - ], - "documentation":"

Removes a device from Alexa For Business.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteDeviceUsageData":{ - "name":"DeleteDeviceUsageData", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDeviceUsageDataRequest"}, - "output":{"shape":"DeleteDeviceUsageDataResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"DeviceNotRegisteredException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteGatewayGroup":{ - "name":"DeleteGatewayGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGatewayGroupRequest"}, - "output":{"shape":"DeleteGatewayGroupResponse"}, - "errors":[ - {"shape":"ResourceAssociatedException"} - ], - "documentation":"

Deletes a gateway group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteNetworkProfile":{ - "name":"DeleteNetworkProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkProfileRequest"}, - "output":{"shape":"DeleteNetworkProfileResponse"}, - "errors":[ - {"shape":"ResourceInUseException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} - ], - "documentation":"

Deletes a network profile by the network profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteProfile":{ - "name":"DeleteProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProfileRequest"}, - "output":{"shape":"DeleteProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a room profile by the profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteRoom":{ - "name":"DeleteRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRoomRequest"}, - "output":{"shape":"DeleteRoomResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a room by the room ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteRoomSkillParameter":{ - "name":"DeleteRoomSkillParameter", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRoomSkillParameterRequest"}, - "output":{"shape":"DeleteRoomSkillParameterResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes room skill parameter details by room, skill, and parameter key ID.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteSkillAuthorization":{ - "name":"DeleteSkillAuthorization", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSkillAuthorizationRequest"}, - "output":{"shape":"DeleteSkillAuthorizationResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Unlinks a third-party account from a skill.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteSkillGroup":{ - "name":"DeleteSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSkillGroupRequest"}, - "output":{"shape":"DeleteSkillGroupResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a skill group by skill group ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DeleteUser":{ - "name":"DeleteUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserRequest"}, - "output":{"shape":"DeleteUserResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a specified user by user ARN and enrollment ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DisassociateContactFromAddressBook":{ - "name":"DisassociateContactFromAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateContactFromAddressBookRequest"}, - "output":{"shape":"DisassociateContactFromAddressBookResponse"}, - "documentation":"

Disassociates a contact from a given address book.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DisassociateDeviceFromRoom":{ - "name":"DisassociateDeviceFromRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateDeviceFromRoomRequest"}, - "output":{"shape":"DisassociateDeviceFromRoomResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"DeviceNotRegisteredException"} - ], - "documentation":"

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DisassociateSkillFromSkillGroup":{ - "name":"DisassociateSkillFromSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateSkillFromSkillGroupRequest"}, - "output":{"shape":"DisassociateSkillFromSkillGroupResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} - ], - "documentation":"

Disassociates a skill from a skill group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DisassociateSkillFromUsers":{ - "name":"DisassociateSkillFromUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateSkillFromUsersRequest"}, - "output":{"shape":"DisassociateSkillFromUsersResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} - ], - "documentation":"

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "DisassociateSkillGroupFromRoom":{ - "name":"DisassociateSkillGroupFromRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateSkillGroupFromRoomRequest"}, - "output":{"shape":"DisassociateSkillGroupFromRoomResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ForgetSmartHomeAppliances":{ - "name":"ForgetSmartHomeAppliances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ForgetSmartHomeAppliancesRequest"}, - "output":{"shape":"ForgetSmartHomeAppliancesResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Forgets smart home appliances associated to a room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetAddressBook":{ - "name":"GetAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAddressBookRequest"}, - "output":{"shape":"GetAddressBookResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets address the book details by the address book ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetConferencePreference":{ - "name":"GetConferencePreference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetConferencePreferenceRequest"}, - "output":{"shape":"GetConferencePreferenceResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Retrieves the existing conference preferences.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetConferenceProvider":{ - "name":"GetConferenceProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetConferenceProviderRequest"}, - "output":{"shape":"GetConferenceProviderResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets details about a specific conference provider.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetContact":{ - "name":"GetContact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetContactRequest"}, - "output":{"shape":"GetContactResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets the contact details by the contact ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetDevice":{ - "name":"GetDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetDeviceRequest"}, - "output":{"shape":"GetDeviceResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets the details of a device by device ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetGateway":{ - "name":"GetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGatewayRequest"}, - "output":{"shape":"GetGatewayResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Retrieves the details of a gateway.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetGatewayGroup":{ - "name":"GetGatewayGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGatewayGroupRequest"}, - "output":{"shape":"GetGatewayGroupResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Retrieves the details of a gateway group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetInvitationConfiguration":{ - "name":"GetInvitationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetInvitationConfigurationRequest"}, - "output":{"shape":"GetInvitationConfigurationResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Retrieves the configured values for the user enrollment invitation email template.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetNetworkProfile":{ - "name":"GetNetworkProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetNetworkProfileRequest"}, - "output":{"shape":"GetNetworkProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"InvalidSecretsManagerResourceException"} - ], - "documentation":"

Gets the network profile details by the network profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetProfile":{ - "name":"GetProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetProfileRequest"}, - "output":{"shape":"GetProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets the details of a room profile by profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetRoom":{ - "name":"GetRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRoomRequest"}, - "output":{"shape":"GetRoomResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets room details by room ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetRoomSkillParameter":{ - "name":"GetRoomSkillParameter", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRoomSkillParameterRequest"}, - "output":{"shape":"GetRoomSkillParameterResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets room skill parameter details by room, skill, and parameter key ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "GetSkillGroup":{ - "name":"GetSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSkillGroupRequest"}, - "output":{"shape":"GetSkillGroupResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Gets skill group details by skill group ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListBusinessReportSchedules":{ - "name":"ListBusinessReportSchedules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBusinessReportSchedulesRequest"}, - "output":{"shape":"ListBusinessReportSchedulesResponse"}, - "documentation":"

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListConferenceProviders":{ - "name":"ListConferenceProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListConferenceProvidersRequest"}, - "output":{"shape":"ListConferenceProvidersResponse"}, - "documentation":"

Lists conference providers under a specific AWS account.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListDeviceEvents":{ - "name":"ListDeviceEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDeviceEventsRequest"}, - "output":{"shape":"ListDeviceEventsResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Lists the device event history, including device connection status, for up to 30 days.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListGatewayGroups":{ - "name":"ListGatewayGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGatewayGroupsRequest"}, - "output":{"shape":"ListGatewayGroupsResponse"}, - "documentation":"

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListGateways":{ - "name":"ListGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGatewaysRequest"}, - "output":{"shape":"ListGatewaysResponse"}, - "documentation":"

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListSkills":{ - "name":"ListSkills", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSkillsRequest"}, - "output":{"shape":"ListSkillsResponse"}, - "documentation":"

Lists all enabled skills in a specific skill group.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListSkillsStoreCategories":{ - "name":"ListSkillsStoreCategories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSkillsStoreCategoriesRequest"}, - "output":{"shape":"ListSkillsStoreCategoriesResponse"}, - "documentation":"

Lists all categories in the Alexa skill store.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListSkillsStoreSkillsByCategory":{ - "name":"ListSkillsStoreSkillsByCategory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSkillsStoreSkillsByCategoryRequest"}, - "output":{"shape":"ListSkillsStoreSkillsByCategoryResponse"}, - "documentation":"

Lists all skills in the Alexa skill store by category.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListSmartHomeAppliances":{ - "name":"ListSmartHomeAppliances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSmartHomeAppliancesRequest"}, - "output":{"shape":"ListSmartHomeAppliancesResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Lists all of the smart home appliances associated with a room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ListTags":{ - "name":"ListTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsRequest"}, - "output":{"shape":"ListTagsResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Lists all tags for the specified resource.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "PutConferencePreference":{ - "name":"PutConferencePreference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutConferencePreferenceRequest"}, - "output":{"shape":"PutConferencePreferenceResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Sets the conference preferences on a specific conference provider at the account level.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "PutInvitationConfiguration":{ - "name":"PutInvitationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutInvitationConfigurationRequest"}, - "output":{"shape":"PutInvitationConfigurationResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Configures the email template for the user enrollment invitation with the specified attributes.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "PutRoomSkillParameter":{ - "name":"PutRoomSkillParameter", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutRoomSkillParameterRequest"}, - "output":{"shape":"PutRoomSkillParameterResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "PutSkillAuthorization":{ - "name":"PutSkillAuthorization", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutSkillAuthorizationRequest"}, - "output":{"shape":"PutSkillAuthorizationResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "RegisterAVSDevice":{ - "name":"RegisterAVSDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterAVSDeviceRequest"}, - "output":{"shape":"RegisterAVSDeviceResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"}, - {"shape":"InvalidDeviceException"} - ], - "documentation":"

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "RejectSkill":{ - "name":"RejectSkill", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectSkillRequest"}, - "output":{"shape":"RejectSkillResponse"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} - ], - "documentation":"

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "ResolveRoom":{ - "name":"ResolveRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResolveRoomRequest"}, - "output":{"shape":"ResolveRoomResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "RevokeInvitation":{ - "name":"RevokeInvitation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeInvitationRequest"}, - "output":{"shape":"RevokeInvitationResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Revokes an invitation and invalidates the enrollment URL.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchAddressBooks":{ - "name":"SearchAddressBooks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchAddressBooksRequest"}, - "output":{"shape":"SearchAddressBooksResponse"}, - "documentation":"

Searches address books and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchContacts":{ - "name":"SearchContacts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchContactsRequest"}, - "output":{"shape":"SearchContactsResponse"}, - "documentation":"

Searches contacts and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchDevices":{ - "name":"SearchDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchDevicesRequest"}, - "output":{"shape":"SearchDevicesResponse"}, - "documentation":"

Searches devices and lists the ones that meet a set of filter criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchNetworkProfiles":{ - "name":"SearchNetworkProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchNetworkProfilesRequest"}, - "output":{"shape":"SearchNetworkProfilesResponse"}, - "documentation":"

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchProfiles":{ - "name":"SearchProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchProfilesRequest"}, - "output":{"shape":"SearchProfilesResponse"}, - "documentation":"

Searches room profiles and lists the ones that meet a set of filter criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchRooms":{ - "name":"SearchRooms", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchRoomsRequest"}, - "output":{"shape":"SearchRoomsResponse"}, - "documentation":"

Searches rooms and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchSkillGroups":{ - "name":"SearchSkillGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchSkillGroupsRequest"}, - "output":{"shape":"SearchSkillGroupsResponse"}, - "documentation":"

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SearchUsers":{ - "name":"SearchUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchUsersRequest"}, - "output":{"shape":"SearchUsersResponse"}, - "documentation":"

Searches users and lists the ones that meet a set of filter and sort criteria.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "SendAnnouncement":{ - "name":"SendAnnouncement", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendAnnouncementRequest"}, - "output":{"shape":"SendAnnouncementResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"AlreadyExistsException"} - ], - "documentation":"

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

" - }, - "SendInvitation":{ - "name":"SendInvitation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendInvitationRequest"}, - "output":{"shape":"SendInvitationResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"InvalidUserStatusException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "StartDeviceSync":{ - "name":"StartDeviceSync", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartDeviceSyncRequest"}, - "output":{"shape":"StartDeviceSyncResponse"}, - "errors":[ - {"shape":"DeviceNotRegisteredException"} - ], - "documentation":"

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "StartSmartHomeApplianceDiscovery":{ - "name":"StartSmartHomeApplianceDiscovery", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartSmartHomeApplianceDiscoveryRequest"}, - "output":{"shape":"StartSmartHomeApplianceDiscoveryResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Initiates the discovery of any smart home appliances associated with the room.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Adds metadata tags to a specified resource.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Removes metadata tags from a specified resource.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateAddressBook":{ - "name":"UpdateAddressBook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAddressBookRequest"}, - "output":{"shape":"UpdateAddressBookResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates address book details by the address book ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateBusinessReportSchedule":{ - "name":"UpdateBusinessReportSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateBusinessReportScheduleRequest"}, - "output":{"shape":"UpdateBusinessReportScheduleResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates the configuration of the report delivery schedule with the specified schedule ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateConferenceProvider":{ - "name":"UpdateConferenceProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateConferenceProviderRequest"}, - "output":{"shape":"UpdateConferenceProviderResponse"}, - "errors":[ - {"shape":"NotFoundException"} - ], - "documentation":"

Updates an existing conference provider's settings.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateContact":{ - "name":"UpdateContact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateContactRequest"}, - "output":{"shape":"UpdateContactResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates the contact details by the contact ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateDevice":{ - "name":"UpdateDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDeviceRequest"}, - "output":{"shape":"UpdateDeviceResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"DeviceNotRegisteredException"} - ], - "documentation":"

Updates the device name by device ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateGateway":{ - "name":"UpdateGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGatewayRequest"}, - "output":{"shape":"UpdateGatewayResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"} - ], - "documentation":"

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateGatewayGroup":{ - "name":"UpdateGatewayGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGatewayGroupRequest"}, - "output":{"shape":"UpdateGatewayGroupResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"} - ], - "documentation":"

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateNetworkProfile":{ - "name":"UpdateNetworkProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateNetworkProfileRequest"}, - "output":{"shape":"UpdateNetworkProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidCertificateAuthorityException"}, - {"shape":"InvalidSecretsManagerResourceException"} - ], - "documentation":"

Updates a network profile by the network profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateProfile":{ - "name":"UpdateProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProfileRequest"}, - "output":{"shape":"UpdateProfileResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates an existing room profile by room profile ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateRoom":{ - "name":"UpdateRoom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRoomRequest"}, - "output":{"shape":"UpdateRoomResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"} - ], - "documentation":"

Updates room details by room ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - }, - "UpdateSkillGroup":{ - "name":"UpdateSkillGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSkillGroupRequest"}, - "output":{"shape":"UpdateSkillGroupResponse"}, - "errors":[ - {"shape":"NotFoundException"}, - {"shape":"NameInUseException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates skill group details by skill group ARN.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" - } - }, - "shapes":{ - "Address":{ - "type":"string", - "max":500, - "min":1 - }, - "AddressBook":{ - "type":"structure", - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book.

" - }, - "Name":{ - "shape":"AddressBookName", - "documentation":"

The name of the address book.

" - }, - "Description":{ - "shape":"AddressBookDescription", - "documentation":"

The description of the address book.

" - } - }, - "documentation":"

An address book with attributes.

" - }, - "AddressBookData":{ - "type":"structure", - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book.

" - }, - "Name":{ - "shape":"AddressBookName", - "documentation":"

The name of the address book.

" - }, - "Description":{ - "shape":"AddressBookDescription", - "documentation":"

The description of the address book.

" - } - }, - "documentation":"

Information related to an address book.

" - }, - "AddressBookDataList":{ - "type":"list", - "member":{"shape":"AddressBookData"} - }, - "AddressBookDescription":{ - "type":"string", - "max":200, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "AddressBookName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "AlreadyExistsException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The resource being created already exists.

", - "exception":true - }, - "AmazonId":{ - "type":"string", - "pattern":"[a-zA-Z0-9]{1,18}" - }, - "ApplianceDescription":{"type":"string"}, - "ApplianceFriendlyName":{"type":"string"}, - "ApplianceManufacturerName":{"type":"string"}, - "ApproveSkillRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The unique identifier of the skill.

" - } - } - }, - "ApproveSkillResponse":{ - "type":"structure", - "members":{ - } - }, - "Arn":{ - "type":"string", - "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" - }, - "AssociateContactWithAddressBookRequest":{ - "type":"structure", - "required":[ - "ContactArn", - "AddressBookArn" - ], - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact to associate with an address book.

" - }, - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book with which to associate the contact.

" - } - } - }, - "AssociateContactWithAddressBookResponse":{ - "type":"structure", - "members":{ - } - }, - "AssociateDeviceWithNetworkProfileRequest":{ - "type":"structure", - "required":[ - "DeviceArn", - "NetworkProfileArn" - ], - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The device ARN.

" - }, - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile to associate with a device.

" - } - } - }, - "AssociateDeviceWithNetworkProfileResponse":{ - "type":"structure", - "members":{ - } - }, - "AssociateDeviceWithRoomRequest":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device to associate to a room. Required.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room with which to associate the device. Required.

" - } - } - }, - "AssociateDeviceWithRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "AssociateSkillGroupWithRoomRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group to associate with a room. Required.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room with which to associate the skill group. Required.

" - } - } - }, - "AssociateSkillGroupWithRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "AssociateSkillWithSkillGroupRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group to associate the skill to. Required.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The unique identifier of the skill.

" - } - } - }, - "AssociateSkillWithSkillGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "AssociateSkillWithUsersRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The private skill ID you want to make available to enrolled users.

" - } - } - }, - "AssociateSkillWithUsersResponse":{ - "type":"structure", - "members":{ - } - }, - "Audio":{ - "type":"structure", - "required":[ - "Locale", - "Location" - ], - "members":{ - "Locale":{ - "shape":"Locale", - "documentation":"

The locale of the audio message. Currently, en-US is supported.

" - }, - "Location":{ - "shape":"AudioLocation", - "documentation":"

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

" - } - }, - "documentation":"

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:

ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>

" - }, - "AudioList":{ - "type":"list", - "member":{"shape":"Audio"}, - "max":1 - }, - "AudioLocation":{ - "type":"string", - "max":1200, - "min":0, - "pattern":"https://([A-Za-z0-9_.-]+)?(s3-[A-Za-z0-9-]+|s3\\.([A-Za-z0-9-])+|s3|s3.dualstack\\.([A-Za-z0-9-])+)+.amazonaws.com/.*" - }, - "AuthorizationResult":{ - "type":"map", - "key":{"shape":"Key"}, - "value":{"shape":"Value"}, - "sensitive":true - }, - "Boolean":{"type":"boolean"}, - "BulletPoint":{"type":"string"}, - "BulletPoints":{ - "type":"list", - "member":{"shape":"BulletPoint"} - }, - "BusinessReport":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"BusinessReportStatus", - "documentation":"

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

" - }, - "FailureCode":{ - "shape":"BusinessReportFailureCode", - "documentation":"

The failure code.

" - }, - "S3Location":{ - "shape":"BusinessReportS3Location", - "documentation":"

The S3 location of the output reports.

" - }, - "DeliveryTime":{ - "shape":"BusinessReportDeliveryTime", - "documentation":"

The time of report delivery.

" - }, - "DownloadUrl":{ - "shape":"BusinessReportDownloadUrl", - "documentation":"

The download link where a user can download the report.

" - } - }, - "documentation":"

Usage report with specified parameters.

" - }, - "BusinessReportContentRange":{ - "type":"structure", - "required":["Interval"], - "members":{ - "Interval":{ - "shape":"BusinessReportInterval", - "documentation":"

The interval of the content range.

" - } - }, - "documentation":"

The content range of the report.

" - }, - "BusinessReportDeliveryTime":{"type":"timestamp"}, - "BusinessReportDownloadUrl":{"type":"string"}, - "BusinessReportFailureCode":{ - "type":"string", - "enum":[ - "ACCESS_DENIED", - "NO_SUCH_BUCKET", - "INTERNAL_FAILURE" - ] - }, - "BusinessReportFormat":{ - "type":"string", - "enum":[ - "CSV", - "CSV_ZIP" - ] - }, - "BusinessReportInterval":{ - "type":"string", - "enum":[ - "ONE_DAY", - "ONE_WEEK", - "THIRTY_DAYS" - ] - }, - "BusinessReportRecurrence":{ - "type":"structure", - "members":{ - "StartDate":{ - "shape":"Date", - "documentation":"

The start date.

" - } - }, - "documentation":"

The recurrence of the reports.

" - }, - "BusinessReportS3Location":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"BusinessReportS3Path", - "documentation":"

The path of the business report.

" - }, - "BucketName":{ - "shape":"CustomerS3BucketName", - "documentation":"

The S3 bucket name of the output reports.

" - } - }, - "documentation":"

The S3 location of the output reports.

" - }, - "BusinessReportS3Path":{"type":"string"}, - "BusinessReportSchedule":{ - "type":"structure", - "members":{ - "ScheduleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the business report schedule.

" - }, - "ScheduleName":{ - "shape":"BusinessReportScheduleName", - "documentation":"

The name identifier of the schedule.

" - }, - "S3BucketName":{ - "shape":"CustomerS3BucketName", - "documentation":"

The S3 bucket name of the output reports.

" - }, - "S3KeyPrefix":{ - "shape":"S3KeyPrefix", - "documentation":"

The S3 key where the report is delivered.

" - }, - "Format":{ - "shape":"BusinessReportFormat", - "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" - }, - "ContentRange":{ - "shape":"BusinessReportContentRange", - "documentation":"

The content range of the reports.

" - }, - "Recurrence":{ - "shape":"BusinessReportRecurrence", - "documentation":"

The recurrence of the reports.

" - }, - "LastBusinessReport":{ - "shape":"BusinessReport", - "documentation":"

The details of the last business report delivery for a specified time interval.

" - } - }, - "documentation":"

The schedule of the usage report.

" - }, - "BusinessReportScheduleList":{ - "type":"list", - "member":{"shape":"BusinessReportSchedule"} - }, - "BusinessReportScheduleName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "BusinessReportStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "SUCCEEDED", - "FAILED" - ] - }, - "Category":{ - "type":"structure", - "members":{ - "CategoryId":{ - "shape":"CategoryId", - "documentation":"

The ID of the skill store category.

" - }, - "CategoryName":{ - "shape":"CategoryName", - "documentation":"

The name of the skill store category.

" - } - }, - "documentation":"

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

" - }, - "CategoryId":{ - "type":"long", - "min":1 - }, - "CategoryList":{ - "type":"list", - "member":{"shape":"Category"} - }, - "CategoryName":{"type":"string"}, - "CertificateTime":{"type":"timestamp"}, - "ClientId":{ - "type":"string", - "pattern":"^\\S+{1,256}$" - }, - "ClientRequestToken":{ - "type":"string", - "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", - "max":150, - "min":10, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" - }, - "CommsProtocol":{ - "type":"string", - "enum":[ - "SIP", - "SIPS", - "H323" - ] - }, - "ConcurrentModificationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

There is a concurrent modification of resources.

", - "exception":true - }, - "ConferencePreference":{ - "type":"structure", - "members":{ - "DefaultConferenceProviderArn":{ - "shape":"Arn", - "documentation":"

The ARN of the default conference provider.

" - } - }, - "documentation":"

The default conference provider that is used if no other scheduled meetings are detected.

" - }, - "ConferenceProvider":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created conference provider.

" - }, - "Name":{ - "shape":"ConferenceProviderName", - "documentation":"

The name of the conference provider.

" - }, - "Type":{ - "shape":"ConferenceProviderType", - "documentation":"

The type of conference providers.

" - }, - "IPDialIn":{ - "shape":"IPDialIn", - "documentation":"

The IP endpoint and protocol for calling.

" - }, - "PSTNDialIn":{ - "shape":"PSTNDialIn", - "documentation":"

The information for PSTN conferencing.

" - }, - "MeetingSetting":{ - "shape":"MeetingSetting", - "documentation":"

The meeting settings for the conference provider.

" - } - }, - "documentation":"

An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

" - }, - "ConferenceProviderName":{ - "type":"string", - "max":50, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "ConferenceProviderType":{ - "type":"string", - "enum":[ - "CHIME", - "BLUEJEANS", - "FUZE", - "GOOGLE_HANGOUTS", - "POLYCOM", - "RINGCENTRAL", - "SKYPE_FOR_BUSINESS", - "WEBEX", - "ZOOM", - "CUSTOM" - ] - }, - "ConferenceProvidersList":{ - "type":"list", - "member":{"shape":"ConferenceProvider"} - }, - "ConnectionStatus":{ - "type":"string", - "enum":[ - "ONLINE", - "OFFLINE" - ] - }, - "ConnectionStatusUpdatedTime":{"type":"timestamp"}, - "Contact":{ - "type":"structure", - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact.

" - }, - "DisplayName":{ - "shape":"ContactName", - "documentation":"

The name of the contact to display on the console.

" - }, - "FirstName":{ - "shape":"ContactName", - "documentation":"

The first name of the contact, used to call the contact on the device.

" - }, - "LastName":{ - "shape":"ContactName", - "documentation":"

The last name of the contact, used to call the contact on the device.

" - }, - "PhoneNumber":{ - "shape":"RawPhoneNumber", - "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" - }, - "PhoneNumbers":{ - "shape":"PhoneNumberList", - "documentation":"

The list of phone numbers for the contact.

" - }, - "SipAddresses":{ - "shape":"SipAddressList", - "documentation":"

The list of SIP addresses for the contact.

" - } - }, - "documentation":"

A contact with attributes.

" - }, - "ContactData":{ - "type":"structure", - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact.

" - }, - "DisplayName":{ - "shape":"ContactName", - "documentation":"

The name of the contact to display on the console.

" - }, - "FirstName":{ - "shape":"ContactName", - "documentation":"

The first name of the contact, used to call the contact on the device.

" - }, - "LastName":{ - "shape":"ContactName", - "documentation":"

The last name of the contact, used to call the contact on the device.

" - }, - "PhoneNumber":{ - "shape":"RawPhoneNumber", - "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" - }, - "PhoneNumbers":{ - "shape":"PhoneNumberList", - "documentation":"

The list of phone numbers for the contact.

" - }, - "SipAddresses":{ - "shape":"SipAddressList", - "documentation":"

The list of SIP addresses for the contact.

" - } - }, - "documentation":"

Information related to a contact.

" - }, - "ContactDataList":{ - "type":"list", - "member":{"shape":"ContactData"} - }, - "ContactName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "Content":{ - "type":"structure", - "members":{ - "TextList":{ - "shape":"TextList", - "documentation":"

The list of text messages.

" - }, - "SsmlList":{ - "shape":"SsmlList", - "documentation":"

The list of SSML messages.

" - }, - "AudioList":{ - "shape":"AudioList", - "documentation":"

The list of audio messages.

" - } - }, - "documentation":"

The content definition. This can contain only one text, SSML, or audio list object.

" - }, - "CountryCode":{ - "type":"string", - "pattern":"\\d{1,3}" - }, - "CreateAddressBookRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"AddressBookName", - "documentation":"

The name of the address book.

" - }, - "Description":{ - "shape":"AddressBookDescription", - "documentation":"

The description of the address book.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "CreateAddressBookResponse":{ - "type":"structure", - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created address book.

" - } - } - }, - "CreateBusinessReportScheduleRequest":{ - "type":"structure", - "required":[ - "Format", - "ContentRange" - ], - "members":{ - "ScheduleName":{ - "shape":"BusinessReportScheduleName", - "documentation":"

The name identifier of the schedule.

" - }, - "S3BucketName":{ - "shape":"CustomerS3BucketName", - "documentation":"

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

" - }, - "S3KeyPrefix":{ - "shape":"S3KeyPrefix", - "documentation":"

The S3 key where the report is delivered.

" - }, - "Format":{ - "shape":"BusinessReportFormat", - "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" - }, - "ContentRange":{ - "shape":"BusinessReportContentRange", - "documentation":"

The content range of the reports.

" - }, - "Recurrence":{ - "shape":"BusinessReportRecurrence", - "documentation":"

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The client request token.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags for the business report schedule.

" - } - } - }, - "CreateBusinessReportScheduleResponse":{ - "type":"structure", - "members":{ - "ScheduleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the business report schedule.

" - } - } - }, - "CreateConferenceProviderRequest":{ - "type":"structure", - "required":[ - "ConferenceProviderName", - "ConferenceProviderType", - "MeetingSetting" - ], - "members":{ - "ConferenceProviderName":{ - "shape":"ConferenceProviderName", - "documentation":"

The name of the conference provider.

" - }, - "ConferenceProviderType":{ - "shape":"ConferenceProviderType", - "documentation":"

Represents a type within a list of predefined types.

" - }, - "IPDialIn":{ - "shape":"IPDialIn", - "documentation":"

The IP endpoint and protocol for calling.

" - }, - "PSTNDialIn":{ - "shape":"PSTNDialIn", - "documentation":"

The information for PSTN conferencing.

" - }, - "MeetingSetting":{ - "shape":"MeetingSetting", - "documentation":"

The meeting settings for the conference provider.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The request token of the client.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "CreateConferenceProviderResponse":{ - "type":"structure", - "members":{ - "ConferenceProviderArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly-created conference provider.

" - } - } - }, - "CreateContactRequest":{ - "type":"structure", - "required":["FirstName"], - "members":{ - "DisplayName":{ - "shape":"ContactName", - "documentation":"

The name of the contact to display on the console.

" - }, - "FirstName":{ - "shape":"ContactName", - "documentation":"

The first name of the contact that is used to call the contact on the device.

" - }, - "LastName":{ - "shape":"ContactName", - "documentation":"

The last name of the contact that is used to call the contact on the device.

" - }, - "PhoneNumber":{ - "shape":"RawPhoneNumber", - "documentation":"

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" - }, - "PhoneNumbers":{ - "shape":"PhoneNumberList", - "documentation":"

The list of phone numbers for the contact.

" - }, - "SipAddresses":{ - "shape":"SipAddressList", - "documentation":"

The list of SIP addresses for the contact.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "CreateContactResponse":{ - "type":"structure", - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created address book.

" - } - } - }, - "CreateEndOfMeetingReminder":{ - "type":"structure", - "required":[ - "ReminderAtMinutes", - "ReminderType", - "Enabled" - ], - "members":{ - "ReminderAtMinutes":{ - "shape":"EndOfMeetingReminderMinutesList", - "documentation":"

A range of 3 to 15 minutes that determines when the reminder begins.

" - }, - "ReminderType":{ - "shape":"EndOfMeetingReminderType", - "documentation":"

The type of sound that users hear during the end of meeting reminder.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether an end of meeting reminder is enabled or not.

" - } - }, - "documentation":"

Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "CreateGatewayGroupRequest":{ - "type":"structure", - "required":[ - "Name", - "ClientRequestToken" - ], - "members":{ - "Name":{ - "shape":"GatewayGroupName", - "documentation":"

The name of the gateway group.

" - }, - "Description":{ - "shape":"GatewayGroupDescription", - "documentation":"

The description of the gateway group.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "CreateGatewayGroupResponse":{ - "type":"structure", - "members":{ - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the created gateway group.

" - } - } - }, - "CreateInstantBooking":{ - "type":"structure", - "required":[ - "DurationInMinutes", - "Enabled" - ], - "members":{ - "DurationInMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether instant booking is enabled or not.

" - } - }, - "documentation":"

Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

" - }, - "CreateMeetingRoomConfiguration":{ - "type":"structure", - "members":{ - "RoomUtilizationMetricsEnabled":{ - "shape":"Boolean", - "documentation":"

Whether room utilization metrics are enabled or not.

" - }, - "EndOfMeetingReminder":{"shape":"CreateEndOfMeetingReminder"}, - "InstantBooking":{ - "shape":"CreateInstantBooking", - "documentation":"

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

" - }, - "RequireCheckIn":{ - "shape":"CreateRequireCheckIn", - "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" - }, - "ProactiveJoin":{"shape":"CreateProactiveJoin"} - }, - "documentation":"

Creates meeting room settings of a room profile.

" - }, - "CreateNetworkProfileRequest":{ - "type":"structure", - "required":[ - "NetworkProfileName", - "Ssid", - "SecurityType", - "ClientRequestToken" - ], - "members":{ - "NetworkProfileName":{ - "shape":"NetworkProfileName", - "documentation":"

The name of the network profile associated with a device.

" - }, - "Description":{ - "shape":"NetworkProfileDescription", - "documentation":"

Detailed information about a device's network profile.

" - }, - "Ssid":{ - "shape":"NetworkSsid", - "documentation":"

The SSID of the Wi-Fi network.

" - }, - "SecurityType":{ - "shape":"NetworkSecurityType", - "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" - }, - "EapMethod":{ - "shape":"NetworkEapMethod", - "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" - }, - "CurrentPassword":{ - "shape":"CurrentWiFiPassword", - "documentation":"

The current password of the Wi-Fi network.

" - }, - "NextPassword":{ - "shape":"NextWiFiPassword", - "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" - }, - "CertificateAuthorityArn":{ - "shape":"Arn", - "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" - }, - "TrustAnchors":{ - "shape":"TrustAnchorList", - "documentation":"

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "CreateNetworkProfileResponse":{ - "type":"structure", - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - } - } - }, - "CreateProactiveJoin":{ - "type":"structure", - "required":["EnabledByMotion"], - "members":{ - "EnabledByMotion":{"shape":"Boolean"} - } - }, - "CreateProfileRequest":{ - "type":"structure", - "required":[ - "ProfileName", - "Timezone", - "Address", - "DistanceUnit", - "TemperatureUnit", - "WakeWord" - ], - "members":{ - "ProfileName":{ - "shape":"ProfileName", - "documentation":"

The name of a room profile.

" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"

The time zone used by a room profile.

" - }, - "Address":{ - "shape":"Address", - "documentation":"

The valid address for the room.

" - }, - "DistanceUnit":{ - "shape":"DistanceUnit", - "documentation":"

The distance unit to be used by devices in the profile.

" - }, - "TemperatureUnit":{ - "shape":"TemperatureUnit", - "documentation":"

The temperature unit to be used by devices in the profile.

" - }, - "WakeWord":{ - "shape":"WakeWord", - "documentation":"

A wake word for Alexa, Echo, Amazon, or a computer.

" - }, - "Locale":{ - "shape":"DeviceLocale", - "documentation":"

The locale of the room profile. (This is currently only available to a limited preview audience.)

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The user-specified token that is used during the creation of a profile.

", - "idempotencyToken":true - }, - "SetupModeDisabled":{ - "shape":"Boolean", - "documentation":"

Whether room profile setup is enabled.

" - }, - "MaxVolumeLimit":{ - "shape":"MaxVolumeLimit", - "documentation":"

The maximum volume limit for a room profile.

" - }, - "PSTNEnabled":{ - "shape":"Boolean", - "documentation":"

Whether PSTN calling is enabled.

" - }, - "DataRetentionOptIn":{ - "shape":"Boolean", - "documentation":"

Whether data retention of the profile is enabled.

" - }, - "MeetingRoomConfiguration":{ - "shape":"CreateMeetingRoomConfiguration", - "documentation":"

The meeting room settings of a room profile.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags for the profile.

" - } - } - }, - "CreateProfileResponse":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created room profile in the response.

" - } - } - }, - "CreateRequireCheckIn":{ - "type":"structure", - "required":[ - "ReleaseAfterMinutes", - "Enabled" - ], - "members":{ - "ReleaseAfterMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether require check in is enabled or not.

" - } - }, - "documentation":"

Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" - }, - "CreateRoomRequest":{ - "type":"structure", - "required":["RoomName"], - "members":{ - "RoomName":{ - "shape":"RoomName", - "documentation":"

The name for the room.

" - }, - "Description":{ - "shape":"RoomDescription", - "documentation":"

The description for the room.

" - }, - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The profile ARN for the room. This is required.

" - }, - "ProviderCalendarId":{ - "shape":"ProviderCalendarId", - "documentation":"

The calendar ARN for the room.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags for the room.

" - } - } - }, - "CreateRoomResponse":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created room in the response.

" - } - } - }, - "CreateSkillGroupRequest":{ - "type":"structure", - "required":["SkillGroupName"], - "members":{ - "SkillGroupName":{ - "shape":"SkillGroupName", - "documentation":"

The name for the skill group.

" - }, - "Description":{ - "shape":"SkillGroupDescription", - "documentation":"

The description for the skill group.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags for the skill group.

" - } - } - }, - "CreateSkillGroupResponse":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created skill group in the response.

" - } - } - }, - "CreateUserRequest":{ - "type":"structure", - "required":["UserId"], - "members":{ - "UserId":{ - "shape":"user_UserId", - "documentation":"

The ARN for the user.

" - }, - "FirstName":{ - "shape":"user_FirstName", - "documentation":"

The first name for the user.

" - }, - "LastName":{ - "shape":"user_LastName", - "documentation":"

The last name for the user.

" - }, - "Email":{ - "shape":"Email", - "documentation":"

The email address for the user.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags for the user.

" - } - } - }, - "CreateUserResponse":{ - "type":"structure", - "members":{ - "UserArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created user in the response.

" - } - } - }, - "CurrentWiFiPassword":{ - "type":"string", - "max":128, - "min":5, - "pattern":"[\\x00-\\x7F]*", - "sensitive":true - }, - "CustomerS3BucketName":{ - "type":"string", - "pattern":"[a-z0-9-\\.]{3,63}" - }, - "Date":{ - "type":"string", - "pattern":"^\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" - }, - "DeleteAddressBookRequest":{ - "type":"structure", - "required":["AddressBookArn"], - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book to delete.

" - } - } - }, - "DeleteAddressBookResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteBusinessReportScheduleRequest":{ - "type":"structure", - "required":["ScheduleArn"], - "members":{ - "ScheduleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the business report schedule.

" - } - } - }, - "DeleteBusinessReportScheduleResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteConferenceProviderRequest":{ - "type":"structure", - "required":["ConferenceProviderArn"], - "members":{ - "ConferenceProviderArn":{ - "shape":"Arn", - "documentation":"

The ARN of the conference provider.

" - } - } - }, - "DeleteConferenceProviderResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteContactRequest":{ - "type":"structure", - "required":["ContactArn"], - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact to delete.

" - } - } - }, - "DeleteContactResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteDeviceRequest":{ - "type":"structure", - "required":["DeviceArn"], - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device for which to request details.

" - } - } - }, - "DeleteDeviceResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteDeviceUsageDataRequest":{ - "type":"structure", - "required":[ - "DeviceArn", - "DeviceUsageType" - ], - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device.

" - }, - "DeviceUsageType":{ - "shape":"DeviceUsageType", - "documentation":"

The type of usage data to delete.

" - } - } - }, - "DeleteDeviceUsageDataResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteGatewayGroupRequest":{ - "type":"structure", - "required":["GatewayGroupArn"], - "members":{ - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group to delete.

" - } - } - }, - "DeleteGatewayGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteNetworkProfileRequest":{ - "type":"structure", - "required":["NetworkProfileArn"], - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - } - } - }, - "DeleteNetworkProfileResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteProfileRequest":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room profile to delete. Required.

" - } - } - }, - "DeleteProfileResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteRoomRequest":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room to delete. Required.

" - } - } - }, - "DeleteRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteRoomSkillParameterRequest":{ - "type":"structure", - "required":[ - "SkillId", - "ParameterKey" - ], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room from which to remove the room skill parameter details.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ID of the skill from which to remove the room skill parameter details.

" - }, - "ParameterKey":{ - "shape":"RoomSkillParameterKey", - "documentation":"

The room skill parameter key for which to remove details.

" - } - } - }, - "DeleteRoomSkillParameterResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteSkillAuthorizationRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The unique identifier of a skill.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room that the skill is authorized for.

" - } - } - }, - "DeleteSkillAuthorizationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteSkillGroupRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group to delete. Required.

" - } - } - }, - "DeleteSkillGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteUserRequest":{ - "type":"structure", - "required":["EnrollmentId"], - "members":{ - "UserArn":{ - "shape":"Arn", - "documentation":"

The ARN of the user to delete in the organization. Required.

" - }, - "EnrollmentId":{ - "shape":"EnrollmentId", - "documentation":"

The ARN of the user's enrollment in the organization. Required.

" - } - } - }, - "DeleteUserResponse":{ - "type":"structure", - "members":{ - } - }, - "DeveloperInfo":{ - "type":"structure", - "members":{ - "DeveloperName":{ - "shape":"DeveloperName", - "documentation":"

The name of the developer.

" - }, - "PrivacyPolicy":{ - "shape":"PrivacyPolicy", - "documentation":"

The URL of the privacy policy.

" - }, - "Email":{ - "shape":"Email", - "documentation":"

The email of the developer.

" - }, - "Url":{ - "shape":"Url", - "documentation":"

The website of the developer.

" - } - }, - "documentation":"

The details about the developer that published the skill.

" - }, - "DeveloperName":{"type":"string"}, - "Device":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of a device.

" - }, - "DeviceSerialNumber":{ - "shape":"DeviceSerialNumber", - "documentation":"

The serial number of a device.

" - }, - "DeviceType":{ - "shape":"DeviceType", - "documentation":"

The type of a device.

" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"

The name of a device.

" - }, - "SoftwareVersion":{ - "shape":"SoftwareVersion", - "documentation":"

The software version of a device.

" - }, - "MacAddress":{ - "shape":"MacAddress", - "documentation":"

The MAC address of a device.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room ARN of a device.

" - }, - "DeviceStatus":{ - "shape":"DeviceStatus", - "documentation":"

The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

" - }, - "DeviceStatusInfo":{ - "shape":"DeviceStatusInfo", - "documentation":"

Detailed information about a device's status.

" - }, - "NetworkProfileInfo":{ - "shape":"DeviceNetworkProfileInfo", - "documentation":"

Detailed information about a device's network profile.

" - } - }, - "documentation":"

A device with attributes.

" - }, - "DeviceData":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of a device.

" - }, - "DeviceSerialNumber":{ - "shape":"DeviceSerialNumber", - "documentation":"

The serial number of a device.

" - }, - "DeviceType":{ - "shape":"DeviceType", - "documentation":"

The type of a device.

" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"

The name of a device.

" - }, - "SoftwareVersion":{ - "shape":"SoftwareVersion", - "documentation":"

The software version of a device.

" - }, - "MacAddress":{ - "shape":"MacAddress", - "documentation":"

The MAC address of a device.

" - }, - "DeviceStatus":{ - "shape":"DeviceStatus", - "documentation":"

The status of a device.

" - }, - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - }, - "NetworkProfileName":{ - "shape":"NetworkProfileName", - "documentation":"

The name of the network profile associated with a device.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room ARN associated with a device.

" - }, - "RoomName":{ - "shape":"DeviceRoomName", - "documentation":"

The name of the room associated with a device.

" - }, - "DeviceStatusInfo":{ - "shape":"DeviceStatusInfo", - "documentation":"

Detailed information about a device's status.

" - }, - "CreatedTime":{ - "shape":"DeviceDataCreatedTime", - "documentation":"

The time (in epoch) when the device data was created.

" - } - }, - "documentation":"

Device attributes.

" - }, - "DeviceDataCreatedTime":{"type":"timestamp"}, - "DeviceDataList":{ - "type":"list", - "member":{"shape":"DeviceData"} - }, - "DeviceEvent":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"DeviceEventType", - "documentation":"

The type of device event.

" - }, - "Value":{ - "shape":"DeviceEventValue", - "documentation":"

The value of the event.

" - }, - "Timestamp":{ - "shape":"DeviceEventTime", - "documentation":"

The time (in epoch) when the event occurred.

" - } - }, - "documentation":"

The list of device events.

" - }, - "DeviceEventList":{ - "type":"list", - "member":{"shape":"DeviceEvent"} - }, - "DeviceEventTime":{"type":"timestamp"}, - "DeviceEventType":{ - "type":"string", - "enum":[ - "CONNECTION_STATUS", - "DEVICE_STATUS" - ] - }, - "DeviceEventValue":{"type":"string"}, - "DeviceLocale":{ - "type":"string", - "max":256, - "min":1 - }, - "DeviceName":{ - "type":"string", - "max":100, - "min":2, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "DeviceNetworkProfileInfo":{ - "type":"structure", - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - }, - "CertificateArn":{ - "shape":"Arn", - "documentation":"

The ARN of the certificate associated with a device.

" - }, - "CertificateExpirationTime":{ - "shape":"CertificateTime", - "documentation":"

The time (in epoch) when the certificate expires.

" - } - }, - "documentation":"

Detailed information about a device's network profile.

" - }, - "DeviceNotRegisteredException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The request failed because this device is no longer registered and therefore no longer managed by this account.

", - "exception":true - }, - "DeviceRoomName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "DeviceSerialNumber":{ - "type":"string", - "pattern":"[a-zA-Z0-9]{1,200}" - }, - "DeviceSerialNumberForAVS":{ - "type":"string", - "pattern":"^[a-zA-Z0-9]{1,50}$" - }, - "DeviceStatus":{ - "type":"string", - "enum":[ - "READY", - "PENDING", - "WAS_OFFLINE", - "DEREGISTERED", - "FAILED" - ] - }, - "DeviceStatusDetail":{ - "type":"structure", - "members":{ - "Feature":{ - "shape":"Feature", - "documentation":"

The list of available features on the device.

" - }, - "Code":{ - "shape":"DeviceStatusDetailCode", - "documentation":"

The device status detail code.

" - } - }, - "documentation":"

Details of a device’s status.

" - }, - "DeviceStatusDetailCode":{ - "type":"string", - "enum":[ - "DEVICE_SOFTWARE_UPDATE_NEEDED", - "DEVICE_WAS_OFFLINE", - "CREDENTIALS_ACCESS_FAILURE", - "TLS_VERSION_MISMATCH", - "ASSOCIATION_REJECTION", - "AUTHENTICATION_FAILURE", - "DHCP_FAILURE", - "INTERNET_UNAVAILABLE", - "DNS_FAILURE", - "UNKNOWN_FAILURE", - "CERTIFICATE_ISSUING_LIMIT_EXCEEDED", - "INVALID_CERTIFICATE_AUTHORITY", - "NETWORK_PROFILE_NOT_FOUND", - "INVALID_PASSWORD_STATE", - "PASSWORD_NOT_FOUND", - "PASSWORD_MANAGER_ACCESS_DENIED", - "CERTIFICATE_AUTHORITY_ACCESS_DENIED" - ] - }, - "DeviceStatusDetails":{ - "type":"list", - "member":{"shape":"DeviceStatusDetail"} - }, - "DeviceStatusInfo":{ - "type":"structure", - "members":{ - "DeviceStatusDetails":{ - "shape":"DeviceStatusDetails", - "documentation":"

One or more device status detail descriptions.

" - }, - "ConnectionStatus":{ - "shape":"ConnectionStatus", - "documentation":"

The latest available information about the connection status of a device.

" - }, - "ConnectionStatusUpdatedTime":{ - "shape":"ConnectionStatusUpdatedTime", - "documentation":"

The time (in epoch) when the device connection status changed.

" - } - }, - "documentation":"

Detailed information about a device's status.

" - }, - "DeviceType":{ - "type":"string", - "pattern":"[a-zA-Z0-9]{1,200}" - }, - "DeviceUsageType":{ - "type":"string", - "enum":["VOICE"] - }, - "DisassociateContactFromAddressBookRequest":{ - "type":"structure", - "required":[ - "ContactArn", - "AddressBookArn" - ], - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact to disassociate from an address book.

" - }, - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address from which to disassociate the contact.

" - } - } - }, - "DisassociateContactFromAddressBookResponse":{ - "type":"structure", - "members":{ - } - }, - "DisassociateDeviceFromRoomRequest":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device to disassociate from a room. Required.

" - } - } - }, - "DisassociateDeviceFromRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "DisassociateSkillFromSkillGroupRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The unique identifier of a skill. Required.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of a skill group to associate to a skill.

" - } - } - }, - "DisassociateSkillFromSkillGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "DisassociateSkillFromUsersRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The private skill ID you want to make unavailable for enrolled users.

" - } - } - }, - "DisassociateSkillFromUsersResponse":{ - "type":"structure", - "members":{ - } - }, - "DisassociateSkillGroupFromRoomRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group to disassociate from a room. Required.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room from which the skill group is to be disassociated. Required.

" - } - } - }, - "DisassociateSkillGroupFromRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "DistanceUnit":{ - "type":"string", - "enum":[ - "METRIC", - "IMPERIAL" - ] - }, - "Email":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\w[+-.\\w]*@\\w[\\w\\.\\-]+\\.[0-9a-zA-Z]{2,24}" - }, - "EnablementType":{ - "type":"string", - "enum":[ - "ENABLED", - "PENDING" - ] - }, - "EnablementTypeFilter":{ - "type":"string", - "enum":[ - "ENABLED", - "PENDING" - ] - }, - "EndOfMeetingReminder":{ - "type":"structure", - "members":{ - "ReminderAtMinutes":{ - "shape":"EndOfMeetingReminderMinutesList", - "documentation":"

A range of 3 to 15 minutes that determines when the reminder begins.

" - }, - "ReminderType":{ - "shape":"EndOfMeetingReminderType", - "documentation":"

The type of sound that users hear during the end of meeting reminder.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether an end of meeting reminder is enabled or not.

" - } - }, - "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "EndOfMeetingReminderMinutesList":{ - "type":"list", - "member":{"shape":"Minutes"}, - "max":1, - "min":1 - }, - "EndOfMeetingReminderType":{ - "type":"string", - "enum":[ - "ANNOUNCEMENT_TIME_CHECK", - "ANNOUNCEMENT_VARIABLE_TIME_LEFT", - "CHIME", - "KNOCK" - ] - }, - "EndUserLicenseAgreement":{"type":"string"}, - "Endpoint":{ - "type":"string", - "max":256, - "min":1 - }, - "EnrollmentId":{ - "type":"string", - "max":128, - "min":0 - }, - "EnrollmentStatus":{ - "type":"string", - "enum":[ - "INITIALIZED", - "PENDING", - "REGISTERED", - "DISASSOCIATING", - "DEREGISTERING" - ] - }, - "ErrorMessage":{"type":"string"}, - "Feature":{ - "type":"string", - "enum":[ - "BLUETOOTH", - "VOLUME", - "NOTIFICATIONS", - "LISTS", - "SKILLS", - "NETWORK_PROFILE", - "SETTINGS", - "ALL" - ] - }, - "Features":{ - "type":"list", - "member":{"shape":"Feature"} - }, - "Filter":{ - "type":"structure", - "required":[ - "Key", - "Values" - ], - "members":{ - "Key":{ - "shape":"FilterKey", - "documentation":"

The key of a filter.

" - }, - "Values":{ - "shape":"FilterValueList", - "documentation":"

The values of a filter.

" - } - }, - "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

" - }, - "FilterKey":{ - "type":"string", - "max":500, - "min":1 - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"}, - "max":25 - }, - "FilterValue":{ - "type":"string", - "max":500, - "min":1 - }, - "FilterValueList":{ - "type":"list", - "member":{"shape":"FilterValue"}, - "max":50 - }, - "ForgetSmartHomeAppliancesRequest":{ - "type":"structure", - "required":["RoomArn"], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room that the appliances are associated with.

" - } - } - }, - "ForgetSmartHomeAppliancesResponse":{ - "type":"structure", - "members":{ - } - }, - "Gateway":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway.

" - }, - "Name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "Description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group that the gateway is associated to.

" - }, - "SoftwareVersion":{ - "shape":"GatewayVersion", - "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" - } - }, - "documentation":"

The details of the gateway.

" - }, - "GatewayDescription":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "GatewayGroup":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group.

" - }, - "Name":{ - "shape":"GatewayGroupName", - "documentation":"

The name of the gateway group.

" - }, - "Description":{ - "shape":"GatewayGroupDescription", - "documentation":"

The description of the gateway group.

" - } - }, - "documentation":"

The details of the gateway group.

" - }, - "GatewayGroupDescription":{ - "type":"string", - "max":200, - "min":0 - }, - "GatewayGroupName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "GatewayGroupSummaries":{ - "type":"list", - "member":{"shape":"GatewayGroupSummary"} - }, - "GatewayGroupSummary":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group.

" - }, - "Name":{ - "shape":"GatewayGroupName", - "documentation":"

The name of the gateway group.

" - }, - "Description":{ - "shape":"GatewayGroupDescription", - "documentation":"

The description of the gateway group.

" - } - }, - "documentation":"

The summary of a gateway group.

" - }, - "GatewayName":{ - "type":"string", - "max":253, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "GatewaySummaries":{ - "type":"list", - "member":{"shape":"GatewaySummary"} - }, - "GatewaySummary":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway.

" - }, - "Name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "Description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group that the gateway is associated to.

" - }, - "SoftwareVersion":{ - "shape":"GatewayVersion", - "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" - } - }, - "documentation":"

The summary of a gateway.

" - }, - "GatewayVersion":{ - "type":"string", - "max":50, - "min":1 - }, - "GenericKeyword":{"type":"string"}, - "GenericKeywords":{ - "type":"list", - "member":{"shape":"GenericKeyword"} - }, - "GetAddressBookRequest":{ - "type":"structure", - "required":["AddressBookArn"], - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book for which to request details.

" - } - } - }, - "GetAddressBookResponse":{ - "type":"structure", - "members":{ - "AddressBook":{ - "shape":"AddressBook", - "documentation":"

The details of the requested address book.

" - } - } - }, - "GetConferencePreferenceRequest":{ - "type":"structure", - "members":{ - } - }, - "GetConferencePreferenceResponse":{ - "type":"structure", - "members":{ - "Preference":{ - "shape":"ConferencePreference", - "documentation":"

The conference preference.

" - } - } - }, - "GetConferenceProviderRequest":{ - "type":"structure", - "required":["ConferenceProviderArn"], - "members":{ - "ConferenceProviderArn":{ - "shape":"Arn", - "documentation":"

The ARN of the newly created conference provider.

" - } - } - }, - "GetConferenceProviderResponse":{ - "type":"structure", - "members":{ - "ConferenceProvider":{ - "shape":"ConferenceProvider", - "documentation":"

The conference provider.

" - } - } - }, - "GetContactRequest":{ - "type":"structure", - "required":["ContactArn"], - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact for which to request details.

" - } - } - }, - "GetContactResponse":{ - "type":"structure", - "members":{ - "Contact":{ - "shape":"Contact", - "documentation":"

The details of the requested contact.

" - } - } - }, - "GetDeviceRequest":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device for which to request details. Required.

" - } - } - }, - "GetDeviceResponse":{ - "type":"structure", - "members":{ - "Device":{ - "shape":"Device", - "documentation":"

The details of the device requested. Required.

" - } - } - }, - "GetGatewayGroupRequest":{ - "type":"structure", - "required":["GatewayGroupArn"], - "members":{ - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group to get.

" - } - } - }, - "GetGatewayGroupResponse":{ - "type":"structure", - "members":{ - "GatewayGroup":{"shape":"GatewayGroup"} - } - }, - "GetGatewayRequest":{ - "type":"structure", - "required":["GatewayArn"], - "members":{ - "GatewayArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway to get.

" - } - } - }, - "GetGatewayResponse":{ - "type":"structure", - "members":{ - "Gateway":{ - "shape":"Gateway", - "documentation":"

The details of the gateway.

" - } - } - }, - "GetInvitationConfigurationRequest":{ - "type":"structure", - "members":{ - } - }, - "GetInvitationConfigurationResponse":{ - "type":"structure", - "members":{ - "OrganizationName":{ - "shape":"OrganizationName", - "documentation":"

The name of the organization sending the enrollment invite to a user.

" - }, - "ContactEmail":{ - "shape":"Email", - "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" - }, - "PrivateSkillIds":{ - "shape":"ShortSkillIdList", - "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" - } - } - }, - "GetNetworkProfileRequest":{ - "type":"structure", - "required":["NetworkProfileArn"], - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - } - } - }, - "GetNetworkProfileResponse":{ - "type":"structure", - "members":{ - "NetworkProfile":{ - "shape":"NetworkProfile", - "documentation":"

The network profile associated with a device.

" - } - } - }, - "GetProfileRequest":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room profile for which to request details. Required.

" - } - } - }, - "GetProfileResponse":{ - "type":"structure", - "members":{ - "Profile":{ - "shape":"Profile", - "documentation":"

The details of the room profile requested. Required.

" - } - } - }, - "GetRoomRequest":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room for which to request details. Required.

" - } - } - }, - "GetRoomResponse":{ - "type":"structure", - "members":{ - "Room":{ - "shape":"Room", - "documentation":"

The details of the room requested.

" - } - } - }, - "GetRoomSkillParameterRequest":{ - "type":"structure", - "required":[ - "SkillId", - "ParameterKey" - ], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room from which to get the room skill parameter details.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of the skill from which to get the room skill parameter details. Required.

" - }, - "ParameterKey":{ - "shape":"RoomSkillParameterKey", - "documentation":"

The room skill parameter key for which to get details. Required.

" - } - } - }, - "GetRoomSkillParameterResponse":{ - "type":"structure", - "members":{ - "RoomSkillParameter":{ - "shape":"RoomSkillParameter", - "documentation":"

The details of the room skill parameter requested. Required.

" - } - } - }, - "GetSkillGroupRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group for which to get details. Required.

" - } - } - }, - "GetSkillGroupResponse":{ - "type":"structure", - "members":{ - "SkillGroup":{ - "shape":"SkillGroup", - "documentation":"

The details of the skill group requested. Required.

" - } - } - }, - "IPDialIn":{ - "type":"structure", - "required":[ - "Endpoint", - "CommsProtocol" - ], - "members":{ - "Endpoint":{ - "shape":"Endpoint", - "documentation":"

The IP address.

" - }, - "CommsProtocol":{ - "shape":"CommsProtocol", - "documentation":"

The protocol, including SIP, SIPS, and H323.

" - } - }, - "documentation":"

The IP endpoint and protocol for calling.

" - }, - "IconUrl":{"type":"string"}, - "InstantBooking":{ - "type":"structure", - "members":{ - "DurationInMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether instant booking is enabled or not.

" - } - }, - "documentation":"

Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

" - }, - "InvalidCertificateAuthorityException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The Certificate Authority can't issue or revoke a certificate.

", - "exception":true - }, - "InvalidDeviceException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The device is in an invalid state.

", - "exception":true - }, - "InvalidSecretsManagerResourceException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

A password in SecretsManager is in an invalid state.

", - "exception":true - }, - "InvalidServiceLinkedRoleStateException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The service linked role is locked for deletion.

", - "exception":true - }, - "InvalidUserStatusException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The attempt to update a user is invalid due to the user's current status.

", - "exception":true - }, - "InvocationPhrase":{"type":"string"}, - "Key":{ - "type":"string", - "min":1 - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

You are performing an action that would put you beyond your account's limits.

", - "exception":true - }, - "ListBusinessReportSchedulesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to list the remaining schedules from the previous API call.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of schedules listed in the call.

" - } - } - }, - "ListBusinessReportSchedulesResponse":{ - "type":"structure", - "members":{ - "BusinessReportSchedules":{ - "shape":"BusinessReportScheduleList", - "documentation":"

The schedule of the reports.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to list the remaining schedules from the previous API call.

" - } - } - }, - "ListConferenceProvidersRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of conference providers to be returned, per paginated calls.

" - } - } - }, - "ListConferenceProvidersResponse":{ - "type":"structure", - "members":{ - "ConferenceProviders":{ - "shape":"ConferenceProvidersList", - "documentation":"

The conference providers.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - } - } - }, - "ListDeviceEventsRequest":{ - "type":"structure", - "required":["DeviceArn"], - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of a device.

" - }, - "EventType":{ - "shape":"DeviceEventType", - "documentation":"

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - } - } - }, - "ListDeviceEventsResponse":{ - "type":"structure", - "members":{ - "DeviceEvents":{ - "shape":"DeviceEventList", - "documentation":"

The device events requested for the device ARN.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - } - } - }, - "ListGatewayGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of gateway group summaries to return. The default is 50.

" - } - } - }, - "ListGatewayGroupsResponse":{ - "type":"structure", - "members":{ - "GatewayGroups":{ - "shape":"GatewayGroupSummaries", - "documentation":"

The gateway groups in the list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" - } - } - }, - "ListGatewaysRequest":{ - "type":"structure", - "members":{ - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The gateway group ARN for which to list gateways.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of gateway summaries to return. The default is 50.

" - } - } - }, - "ListGatewaysResponse":{ - "type":"structure", - "members":{ - "Gateways":{ - "shape":"GatewaySummaries", - "documentation":"

The gateways in the list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" - } - } - }, - "ListSkillsRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group for which to list enabled skills.

" - }, - "EnablementType":{ - "shape":"EnablementTypeFilter", - "documentation":"

Whether the skill is enabled under the user's account.

" - }, - "SkillType":{ - "shape":"SkillTypeFilter", - "documentation":"

Whether the skill is publicly available or is a private skill.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"SkillListMaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - } - } - }, - "ListSkillsResponse":{ - "type":"structure", - "members":{ - "SkillSummaries":{ - "shape":"SkillSummaryList", - "documentation":"

The list of enabled skills requested. Required.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - } - } - }, - "ListSkillsStoreCategoriesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of categories returned, per paginated calls.

" - } - } - }, - "ListSkillsStoreCategoriesResponse":{ - "type":"structure", - "members":{ - "CategoryList":{ - "shape":"CategoryList", - "documentation":"

The list of categories.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - } - } - }, - "ListSkillsStoreSkillsByCategoryRequest":{ - "type":"structure", - "required":["CategoryId"], - "members":{ - "CategoryId":{ - "shape":"CategoryId", - "documentation":"

The category ID for which the skills are being retrieved from the skill store.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - }, - "MaxResults":{ - "shape":"SkillListMaxResults", - "documentation":"

The maximum number of skills returned per paginated calls.

" - } - } - }, - "ListSkillsStoreSkillsByCategoryResponse":{ - "type":"structure", - "members":{ - "SkillsStoreSkills":{ - "shape":"SkillsStoreSkillList", - "documentation":"

The skill store skills.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - } - } - }, - "ListSmartHomeAppliancesRequest":{ - "type":"structure", - "required":["RoomArn"], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room that the appliances are associated with.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of appliances to be returned, per paginated calls.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - } - } - }, - "ListSmartHomeAppliancesResponse":{ - "type":"structure", - "members":{ - "SmartHomeAppliances":{ - "shape":"SmartHomeApplianceList", - "documentation":"

The smart home appliances.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The tokens used for pagination.

" - } - } - }, - "ListTagsRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the specified resource for which to list tags.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - } - } - }, - "ListTagsResponse":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagList", - "documentation":"

The tags requested for the specified resource.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - } - } - }, - "Locale":{ - "type":"string", - "enum":["en-US"] - }, - "MacAddress":{"type":"string"}, - "MaxResults":{ - "type":"integer", - "max":50, - "min":1 - }, - "MaxVolumeLimit":{"type":"integer"}, - "MeetingRoomConfiguration":{ - "type":"structure", - "members":{ - "RoomUtilizationMetricsEnabled":{ - "shape":"Boolean", - "documentation":"

Whether room utilization metrics are enabled or not.

" - }, - "EndOfMeetingReminder":{ - "shape":"EndOfMeetingReminder", - "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "InstantBooking":{ - "shape":"InstantBooking", - "documentation":"

Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.

" - }, - "RequireCheckIn":{ - "shape":"RequireCheckIn", - "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" - }, - "ProactiveJoin":{"shape":"ProactiveJoin"} - }, - "documentation":"

Meeting room settings of a room profile.

" - }, - "MeetingSetting":{ - "type":"structure", - "required":["RequirePin"], - "members":{ - "RequirePin":{ - "shape":"RequirePin", - "documentation":"

The values that indicate whether the pin is always required.

" - } - }, - "documentation":"

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

" - }, - "Minutes":{"type":"integer"}, - "NameInUseException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The name sent in the request is already in use.

", - "exception":true - }, - "NetworkEapMethod":{ - "type":"string", - "enum":["EAP_TLS"] - }, - "NetworkProfile":{ - "type":"structure", - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - }, - "NetworkProfileName":{ - "shape":"NetworkProfileName", - "documentation":"

The name of the network profile associated with a device.

" - }, - "Description":{ - "shape":"NetworkProfileDescription", - "documentation":"

Detailed information about a device's network profile.

" - }, - "Ssid":{ - "shape":"NetworkSsid", - "documentation":"

The SSID of the Wi-Fi network.

" - }, - "SecurityType":{ - "shape":"NetworkSecurityType", - "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" - }, - "EapMethod":{ - "shape":"NetworkEapMethod", - "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" - }, - "CurrentPassword":{ - "shape":"CurrentWiFiPassword", - "documentation":"

The current password of the Wi-Fi network.

" - }, - "NextPassword":{ - "shape":"NextWiFiPassword", - "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" - }, - "CertificateAuthorityArn":{ - "shape":"Arn", - "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" - }, - "TrustAnchors":{ - "shape":"TrustAnchorList", - "documentation":"

The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.

" - } - }, - "documentation":"

The network profile associated with a device.

" - }, - "NetworkProfileData":{ - "type":"structure", - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - }, - "NetworkProfileName":{ - "shape":"NetworkProfileName", - "documentation":"

The name of the network profile associated with a device.

" - }, - "Description":{ - "shape":"NetworkProfileDescription", - "documentation":"

Detailed information about a device's network profile.

" - }, - "Ssid":{ - "shape":"NetworkSsid", - "documentation":"

The SSID of the Wi-Fi network.

" - }, - "SecurityType":{ - "shape":"NetworkSecurityType", - "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" - }, - "EapMethod":{ - "shape":"NetworkEapMethod", - "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" - }, - "CertificateAuthorityArn":{ - "shape":"Arn", - "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" - } - }, - "documentation":"

The data associated with a network profile.

" - }, - "NetworkProfileDataList":{ - "type":"list", - "member":{"shape":"NetworkProfileData"} - }, - "NetworkProfileDescription":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "NetworkProfileName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "NetworkSecurityType":{ - "type":"string", - "enum":[ - "OPEN", - "WEP", - "WPA_PSK", - "WPA2_PSK", - "WPA2_ENTERPRISE" - ] - }, - "NetworkSsid":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "NewInThisVersionBulletPoints":{ - "type":"list", - "member":{"shape":"BulletPoint"} - }, - "NextToken":{ - "type":"string", - "max":1100, - "min":1 - }, - "NextWiFiPassword":{ - "type":"string", - "max":128, - "min":0, - "pattern":"(^$)|([\\x00-\\x7F]{5,})", - "sensitive":true - }, - "NotFoundException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The resource is not found.

", - "exception":true - }, - "OneClickIdDelay":{ - "type":"string", - "max":2, - "min":1 - }, - "OneClickPinDelay":{ - "type":"string", - "max":2, - "min":1 - }, - "OrganizationName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "OutboundPhoneNumber":{ - "type":"string", - "pattern":"\\d{10}" - }, - "PSTNDialIn":{ - "type":"structure", - "required":[ - "CountryCode", - "PhoneNumber", - "OneClickIdDelay", - "OneClickPinDelay" - ], - "members":{ - "CountryCode":{ - "shape":"CountryCode", - "documentation":"

The zip code.

" - }, - "PhoneNumber":{ - "shape":"OutboundPhoneNumber", - "documentation":"

The phone number to call to join the conference.

" - }, - "OneClickIdDelay":{ - "shape":"OneClickIdDelay", - "documentation":"

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" - }, - "OneClickPinDelay":{ - "shape":"OneClickPinDelay", - "documentation":"

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" - } - }, - "documentation":"

The information for public switched telephone network (PSTN) conferencing.

" - }, - "PhoneNumber":{ - "type":"structure", - "required":[ - "Number", - "Type" - ], - "members":{ - "Number":{ - "shape":"RawPhoneNumber", - "documentation":"

The raw value of the phone number.

" - }, - "Type":{ - "shape":"PhoneNumberType", - "documentation":"

The type of the phone number.

" - } - }, - "documentation":"

The phone number for the contact containing the raw number and phone number type.

" - }, - "PhoneNumberList":{ - "type":"list", - "member":{"shape":"PhoneNumber"}, - "max":3, - "min":0 - }, - "PhoneNumberType":{ - "type":"string", - "enum":[ - "MOBILE", - "WORK", - "HOME" - ], - "sensitive":true - }, - "PrivacyPolicy":{"type":"string"}, - "ProactiveJoin":{ - "type":"structure", - "members":{ - "EnabledByMotion":{"shape":"Boolean"} - } - }, - "ProductDescription":{"type":"string"}, - "ProductId":{ - "type":"string", - "pattern":"^[a-zA-Z0-9_]{1,256}$" - }, - "Profile":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of a room profile.

" - }, - "ProfileName":{ - "shape":"ProfileName", - "documentation":"

The name of a room profile.

" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"

Retrieves if the profile is default or not.

" - }, - "Address":{ - "shape":"Address", - "documentation":"

The address of a room profile.

" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"

The time zone of a room profile.

" - }, - "DistanceUnit":{ - "shape":"DistanceUnit", - "documentation":"

The distance unit of a room profile.

" - }, - "TemperatureUnit":{ - "shape":"TemperatureUnit", - "documentation":"

The temperature unit of a room profile.

" - }, - "WakeWord":{ - "shape":"WakeWord", - "documentation":"

The wake word of a room profile.

" - }, - "Locale":{ - "shape":"DeviceLocale", - "documentation":"

The locale of a room profile. (This is currently available only to a limited preview audience.)

" - }, - "SetupModeDisabled":{ - "shape":"Boolean", - "documentation":"

The setup mode of a room profile.

" - }, - "MaxVolumeLimit":{ - "shape":"MaxVolumeLimit", - "documentation":"

The max volume limit of a room profile.

" - }, - "PSTNEnabled":{ - "shape":"Boolean", - "documentation":"

The PSTN setting of a room profile.

" - }, - "DataRetentionOptIn":{ - "shape":"Boolean", - "documentation":"

Whether data retention of the profile is enabled.

" - }, - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the address book.

" - }, - "MeetingRoomConfiguration":{ - "shape":"MeetingRoomConfiguration", - "documentation":"

Meeting room settings of a room profile.

" - } - }, - "documentation":"

A room profile with attributes.

" - }, - "ProfileData":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of a room profile.

" - }, - "ProfileName":{ - "shape":"ProfileName", - "documentation":"

The name of a room profile.

" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"

Retrieves if the profile data is default or not.

" - }, - "Address":{ - "shape":"Address", - "documentation":"

The address of a room profile.

" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"

The time zone of a room profile.

" - }, - "DistanceUnit":{ - "shape":"DistanceUnit", - "documentation":"

The distance unit of a room profile.

" - }, - "TemperatureUnit":{ - "shape":"TemperatureUnit", - "documentation":"

The temperature unit of a room profile.

" - }, - "WakeWord":{ - "shape":"WakeWord", - "documentation":"

The wake word of a room profile.

" - }, - "Locale":{ - "shape":"DeviceLocale", - "documentation":"

The locale of a room profile. (This is currently available only to a limited preview audience.)

" - } - }, - "documentation":"

The data of a room profile.

" - }, - "ProfileDataList":{ - "type":"list", - "member":{"shape":"ProfileData"} - }, - "ProfileName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "ProviderCalendarId":{ - "type":"string", - "max":100, - "min":0 - }, - "PutConferencePreferenceRequest":{ - "type":"structure", - "required":["ConferencePreference"], - "members":{ - "ConferencePreference":{ - "shape":"ConferencePreference", - "documentation":"

The conference preference of a specific conference provider.

" - } - } - }, - "PutConferencePreferenceResponse":{ - "type":"structure", - "members":{ - } - }, - "PutInvitationConfigurationRequest":{ - "type":"structure", - "required":["OrganizationName"], - "members":{ - "OrganizationName":{ - "shape":"OrganizationName", - "documentation":"

The name of the organization sending the enrollment invite to a user.

" - }, - "ContactEmail":{ - "shape":"Email", - "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" - }, - "PrivateSkillIds":{ - "shape":"ShortSkillIdList", - "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" - } - } - }, - "PutInvitationConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "PutRoomSkillParameterRequest":{ - "type":"structure", - "required":[ - "SkillId", - "RoomSkillParameter" - ], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room associated with the room skill parameter. Required.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of the skill associated with the room skill parameter. Required.

" - }, - "RoomSkillParameter":{ - "shape":"RoomSkillParameter", - "documentation":"

The updated room skill parameter. Required.

" - } - } - }, - "PutRoomSkillParameterResponse":{ - "type":"structure", - "members":{ - } - }, - "PutSkillAuthorizationRequest":{ - "type":"structure", - "required":[ - "AuthorizationResult", - "SkillId" - ], - "members":{ - "AuthorizationResult":{ - "shape":"AuthorizationResult", - "documentation":"

The authorization result specific to OAUTH code grant output. \"Code” must be populated in the AuthorizationResult map to establish the authorization.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The unique identifier of a skill.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room that the skill is authorized for.

" - } - } - }, - "PutSkillAuthorizationResponse":{ - "type":"structure", - "members":{ - } - }, - "RawPhoneNumber":{ - "type":"string", - "max":50, - "min":0, - "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$", - "sensitive":true - }, - "RegisterAVSDeviceRequest":{ - "type":"structure", - "required":[ - "ClientId", - "UserCode", - "ProductId", - "AmazonId" - ], - "members":{ - "ClientId":{ - "shape":"ClientId", - "documentation":"

The client ID of the OEM used for code-based linking authorization on an AVS device.

" - }, - "UserCode":{ - "shape":"UserCode", - "documentation":"

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

" - }, - "ProductId":{ - "shape":"ProductId", - "documentation":"

The product ID used to identify your AVS device during authorization.

" - }, - "DeviceSerialNumber":{ - "shape":"DeviceSerialNumberForAVS", - "documentation":"

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

" - }, - "AmazonId":{ - "shape":"AmazonId", - "documentation":"

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

" - }, - "RoomArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" - } - } - }, - "RegisterAVSDeviceResponse":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device.

" - } - } - }, - "RejectSkillRequest":{ - "type":"structure", - "required":["SkillId"], - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The unique identifier of the skill.

" - } - } - }, - "RejectSkillResponse":{ - "type":"structure", - "members":{ - } - }, - "ReleaseDate":{"type":"string"}, - "RequireCheckIn":{ - "type":"structure", - "members":{ - "ReleaseAfterMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether require check in is enabled or not.

" - } - }, - "documentation":"

Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" - }, - "RequirePin":{ - "type":"string", - "enum":[ - "YES", - "NO", - "OPTIONAL" - ] - }, - "ResolveRoomRequest":{ - "type":"structure", - "required":[ - "UserId", - "SkillId" - ], - "members":{ - "UserId":{ - "shape":"UserId", - "documentation":"

The ARN of the user. Required.

" - }, - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of the skill that was requested. Required.

" - } - } - }, - "ResolveRoomResponse":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room from which the skill request was invoked.

" - }, - "RoomName":{ - "shape":"RoomName", - "documentation":"

The name of the room from which the skill request was invoked.

" - }, - "RoomSkillParameters":{ - "shape":"RoomSkillParameters", - "documentation":"

Response to get the room profile request. Required.

" - } - } - }, - "ResourceAssociatedException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Another resource is associated with the resource in the request.

", - "exception":true - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ClientRequestToken":{"shape":"ClientRequestToken"} - }, - "documentation":"

The resource in the request is already in use.

", - "exception":true - }, - "ReviewKey":{"type":"string"}, - "ReviewValue":{"type":"string"}, - "Reviews":{ - "type":"map", - "key":{"shape":"ReviewKey"}, - "value":{"shape":"ReviewValue"} - }, - "RevokeInvitationRequest":{ - "type":"structure", - "members":{ - "UserArn":{ - "shape":"Arn", - "documentation":"

The ARN of the user for whom to revoke an enrollment invitation. Required.

" - }, - "EnrollmentId":{ - "shape":"EnrollmentId", - "documentation":"

The ARN of the enrollment invitation to revoke. Required.

" - } - } - }, - "RevokeInvitationResponse":{ - "type":"structure", - "members":{ - } - }, - "Room":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of a room.

" - }, - "RoomName":{ - "shape":"RoomName", - "documentation":"

The name of a room.

" - }, - "Description":{ - "shape":"RoomDescription", - "documentation":"

The description of a room.

" - }, - "ProviderCalendarId":{ - "shape":"ProviderCalendarId", - "documentation":"

The provider calendar ARN of a room.

" - }, - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The profile ARN of a room.

" - } - }, - "documentation":"

A room with attributes.

" - }, - "RoomData":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of a room.

" - }, - "RoomName":{ - "shape":"RoomName", - "documentation":"

The name of a room.

" - }, - "Description":{ - "shape":"RoomDescription", - "documentation":"

The description of a room.

" - }, - "ProviderCalendarId":{ - "shape":"ProviderCalendarId", - "documentation":"

The provider calendar ARN of a room.

" - }, - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The profile ARN of a room.

" - }, - "ProfileName":{ - "shape":"ProfileName", - "documentation":"

The profile name of a room.

" - } - }, - "documentation":"

The data of a room.

" - }, - "RoomDataList":{ - "type":"list", - "member":{"shape":"RoomData"} - }, - "RoomDescription":{ - "type":"string", - "max":200, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "RoomName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "RoomSkillParameter":{ - "type":"structure", - "required":[ - "ParameterKey", - "ParameterValue" - ], - "members":{ - "ParameterKey":{ - "shape":"RoomSkillParameterKey", - "documentation":"

The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

" - }, - "ParameterValue":{ - "shape":"RoomSkillParameterValue", - "documentation":"

The parameter value of a room skill parameter.

" - } - }, - "documentation":"

A skill parameter associated with a room.

" - }, - "RoomSkillParameterKey":{ - "type":"string", - "max":256, - "min":1 - }, - "RoomSkillParameterValue":{ - "type":"string", - "max":512, - "min":1 - }, - "RoomSkillParameters":{ - "type":"list", - "member":{"shape":"RoomSkillParameter"} - }, - "S3KeyPrefix":{ - "type":"string", - "max":100, - "min":0, - "pattern":"[A-Za-z0-9!_\\-\\.\\*'()/]*" - }, - "SampleUtterances":{ - "type":"list", - "member":{"shape":"Utterance"} - }, - "SearchAddressBooksRequest":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - } - } - }, - "SearchAddressBooksResponse":{ - "type":"structure", - "members":{ - "AddressBooks":{ - "shape":"AddressBookDataList", - "documentation":"

The address books that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of address books returned.

" - } - } - }, - "SearchContactsRequest":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - } - } - }, - "SearchContactsResponse":{ - "type":"structure", - "members":{ - "Contacts":{ - "shape":"ContactDataList", - "documentation":"

The contacts that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of contacts returned.

" - } - } - }, - "SearchDevicesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" - } - } - }, - "SearchDevicesResponse":{ - "type":"structure", - "members":{ - "Devices":{ - "shape":"DeviceDataList", - "documentation":"

The devices that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of devices returned.

" - } - } - }, - "SearchNetworkProfilesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

" - } - } - }, - "SearchNetworkProfilesResponse":{ - "type":"structure", - "members":{ - "NetworkProfiles":{ - "shape":"NetworkProfileDataList", - "documentation":"

The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of network profiles returned.

" - } - } - }, - "SearchProfilesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

" - } - } - }, - "SearchProfilesResponse":{ - "type":"structure", - "members":{ - "Profiles":{ - "shape":"ProfileDataList", - "documentation":"

The profiles that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of room profiles returned.

" - } - } - }, - "SearchRoomsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

" - } - } - }, - "SearchRoomsResponse":{ - "type":"structure", - "members":{ - "Rooms":{ - "shape":"RoomDataList", - "documentation":"

The rooms that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of rooms returned.

" - } - } - }, - "SearchSkillGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

" - } - } - }, - "SearchSkillGroupsResponse":{ - "type":"structure", - "members":{ - "SkillGroups":{ - "shape":"SkillGroupDataList", - "documentation":"

The skill groups that meet the filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of skill groups returned.

" - } - } - }, - "SearchUsersRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" - }, - "SortCriteria":{ - "shape":"SortList", - "documentation":"

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" - } - } - }, - "SearchUsersResponse":{ - "type":"structure", - "members":{ - "Users":{ - "shape":"UserDataList", - "documentation":"

The users that meet the specified set of filter criteria, in sort order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned to indicate that there is more data available.

" - }, - "TotalCount":{ - "shape":"TotalCount", - "documentation":"

The total number of users returned.

" - } - } - }, - "SendAnnouncementRequest":{ - "type":"structure", - "required":[ - "RoomFilters", - "Content", - "ClientRequestToken" - ], - "members":{ - "RoomFilters":{ - "shape":"FilterList", - "documentation":"

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

" - }, - "Content":{ - "shape":"Content", - "documentation":"

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

" - }, - "TimeToLiveInSeconds":{ - "shape":"TimeToLiveInSeconds", - "documentation":"

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

" - }, - "ClientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"

The unique, user-specified identifier for the request that ensures idempotency.

", - "idempotencyToken":true - } - } - }, - "SendAnnouncementResponse":{ - "type":"structure", - "members":{ - "AnnouncementArn":{ - "shape":"Arn", - "documentation":"

The identifier of the announcement.

" - } - } - }, - "SendInvitationRequest":{ - "type":"structure", - "members":{ - "UserArn":{ - "shape":"Arn", - "documentation":"

The ARN of the user to whom to send an invitation. Required.

" - } - } - }, - "SendInvitationResponse":{ - "type":"structure", - "members":{ - } - }, - "ShortDescription":{"type":"string"}, - "ShortSkillIdList":{ - "type":"list", - "member":{"shape":"SkillId"}, - "max":3, - "min":0 - }, - "SipAddress":{ - "type":"structure", - "required":[ - "Uri", - "Type" - ], - "members":{ - "Uri":{ - "shape":"SipUri", - "documentation":"

The URI for the SIP address.

" - }, - "Type":{ - "shape":"SipType", - "documentation":"

The type of the SIP address.

" - } - }, - "documentation":"

The SIP address for the contact containing the URI and SIP address type.

" - }, - "SipAddressList":{ - "type":"list", - "member":{"shape":"SipAddress"}, - "max":1, - "min":0 - }, - "SipType":{ - "type":"string", - "enum":["WORK"], - "sensitive":true - }, - "SipUri":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^sip[s]?:([^@:]+)\\@([^@]+)$", - "sensitive":true - }, - "SkillDetails":{ - "type":"structure", - "members":{ - "ProductDescription":{ - "shape":"ProductDescription", - "documentation":"

The description of the product.

" - }, - "InvocationPhrase":{ - "shape":"InvocationPhrase", - "documentation":"

The phrase used to trigger the skill.

" - }, - "ReleaseDate":{ - "shape":"ReleaseDate", - "documentation":"

The date when the skill was released.

" - }, - "EndUserLicenseAgreement":{ - "shape":"EndUserLicenseAgreement", - "documentation":"

The URL of the end user license agreement.

" - }, - "GenericKeywords":{ - "shape":"GenericKeywords", - "documentation":"

The generic keywords associated with the skill that can be used to find a skill.

" - }, - "BulletPoints":{ - "shape":"BulletPoints", - "documentation":"

The details about what the skill supports organized as bullet points.

" - }, - "NewInThisVersionBulletPoints":{ - "shape":"NewInThisVersionBulletPoints", - "documentation":"

The updates added in bullet points.

" - }, - "SkillTypes":{ - "shape":"SkillTypes", - "documentation":"

The types of skills.

" - }, - "Reviews":{ - "shape":"Reviews", - "documentation":"

This member has been deprecated.

The list of reviews for the skill, including Key and Value pair.

" - }, - "DeveloperInfo":{ - "shape":"DeveloperInfo", - "documentation":"

The details about the developer that published the skill.

" - } - }, - "documentation":"

Granular information about the skill.

" - }, - "SkillGroup":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of a skill group.

" - }, - "SkillGroupName":{ - "shape":"SkillGroupName", - "documentation":"

The name of a skill group.

" - }, - "Description":{ - "shape":"SkillGroupDescription", - "documentation":"

The description of a skill group.

" - } - }, - "documentation":"

A skill group with attributes.

" - }, - "SkillGroupData":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The skill group ARN of a skill group.

" - }, - "SkillGroupName":{ - "shape":"SkillGroupName", - "documentation":"

The skill group name of a skill group.

" - }, - "Description":{ - "shape":"SkillGroupDescription", - "documentation":"

The description of a skill group.

" - } - }, - "documentation":"

The attributes of a skill group.

" - }, - "SkillGroupDataList":{ - "type":"list", - "member":{"shape":"SkillGroupData"} - }, - "SkillGroupDescription":{ - "type":"string", - "max":200, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "SkillGroupName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "SkillId":{ - "type":"string", - "pattern":"(^amzn1\\.ask\\.skill\\.[0-9a-f\\-]{1,200})|(^amzn1\\.echo-sdk-ams\\.app\\.[0-9a-f\\-]{1,200})" - }, - "SkillListMaxResults":{ - "type":"integer", - "max":10, - "min":1 - }, - "SkillName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "SkillNotLinkedException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The skill must be linked to a third-party account.

", - "exception":true - }, - "SkillStoreType":{"type":"string"}, - "SkillSummary":{ - "type":"structure", - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of the skill summary.

" - }, - "SkillName":{ - "shape":"SkillName", - "documentation":"

The name of the skill.

" - }, - "SupportsLinking":{ - "shape":"boolean", - "documentation":"

Linking support for a skill.

" - }, - "EnablementType":{ - "shape":"EnablementType", - "documentation":"

Whether the skill is enabled under the user's account, or if it requires linking to be used.

" - }, - "SkillType":{ - "shape":"SkillType", - "documentation":"

Whether the skill is publicly available or is a private skill.

" - } - }, - "documentation":"

The summary of skills.

" - }, - "SkillSummaryList":{ - "type":"list", - "member":{"shape":"SkillSummary"} - }, - "SkillType":{ - "type":"string", - "enum":[ - "PUBLIC", - "PRIVATE" - ], - "max":100, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" - }, - "SkillTypeFilter":{ - "type":"string", - "enum":[ - "PUBLIC", - "PRIVATE", - "ALL" - ] - }, - "SkillTypes":{ - "type":"list", - "member":{"shape":"SkillStoreType"} - }, - "SkillsStoreSkill":{ - "type":"structure", - "members":{ - "SkillId":{ - "shape":"SkillId", - "documentation":"

The ARN of the skill.

" - }, - "SkillName":{ - "shape":"SkillName", - "documentation":"

The name of the skill.

" - }, - "ShortDescription":{ - "shape":"ShortDescription", - "documentation":"

Short description about the skill.

" - }, - "IconUrl":{ - "shape":"IconUrl", - "documentation":"

The URL where the skill icon resides.

" - }, - "SampleUtterances":{ - "shape":"SampleUtterances", - "documentation":"

Sample utterances that interact with the skill.

" - }, - "SkillDetails":{ - "shape":"SkillDetails", - "documentation":"

Information about the skill.

" - }, - "SupportsLinking":{ - "shape":"boolean", - "documentation":"

Linking support for a skill.

" - } - }, - "documentation":"

The detailed information about an Alexa skill.

" - }, - "SkillsStoreSkillList":{ - "type":"list", - "member":{"shape":"SkillsStoreSkill"} - }, - "SmartHomeAppliance":{ - "type":"structure", - "members":{ - "FriendlyName":{ - "shape":"ApplianceFriendlyName", - "documentation":"

The friendly name of the smart home appliance.

" - }, - "Description":{ - "shape":"ApplianceDescription", - "documentation":"

The description of the smart home appliance.

" - }, - "ManufacturerName":{ - "shape":"ApplianceManufacturerName", - "documentation":"

The name of the manufacturer of the smart home appliance.

" - } - }, - "documentation":"

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

" - }, - "SmartHomeApplianceList":{ - "type":"list", - "member":{"shape":"SmartHomeAppliance"} - }, - "SoftwareVersion":{"type":"string"}, - "Sort":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"SortKey", - "documentation":"

The sort key of a sort object.

" - }, - "Value":{ - "shape":"SortValue", - "documentation":"

The sort value of a sort object.

" - } - }, - "documentation":"

An object representing a sort criteria.

" - }, - "SortKey":{ - "type":"string", - "max":500, - "min":1 - }, - "SortList":{ - "type":"list", - "member":{"shape":"Sort"}, - "max":25 - }, - "SortValue":{ - "type":"string", - "enum":[ - "ASC", - "DESC" - ] - }, - "Ssml":{ - "type":"structure", - "required":[ - "Locale", - "Value" - ], - "members":{ - "Locale":{ - "shape":"Locale", - "documentation":"

The locale of the SSML message. Currently, en-US is supported.

" - }, - "Value":{ - "shape":"SsmlValue", - "documentation":"

The value of the SSML message in the correct SSML format. The audio tag is not supported.

" - } - }, - "documentation":"

The SSML message. For more information, see SSML Reference.

" - }, - "SsmlList":{ - "type":"list", - "member":{"shape":"Ssml"}, - "max":1 - }, - "SsmlValue":{ - "type":"string", - "max":4096, - "min":0, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "StartDeviceSyncRequest":{ - "type":"structure", - "required":["Features"], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room with which the device to sync is associated. Required.

" - }, - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device to sync. Required.

" - }, - "Features":{ - "shape":"Features", - "documentation":"

Request structure to start the device sync. Required.

" - } - } - }, - "StartDeviceSyncResponse":{ - "type":"structure", - "members":{ - } - }, - "StartSmartHomeApplianceDiscoveryRequest":{ - "type":"structure", - "required":["RoomArn"], - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The room where smart home appliance discovery was initiated.

" - } - } - }, - "StartSmartHomeApplianceDiscoveryResponse":{ - "type":"structure", - "members":{ - } - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"

The key of a tag. Tag keys are case-sensitive.

" - }, - "Value":{ - "shape":"TagValue", - "documentation":"

The value of a tag. Tag values are case sensitive and can be null.

" - } - }, - "documentation":"

A key-value pair that can be associated with a resource.

" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "Arn", - "Tags" - ], - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the resource to which to add metadata tags. Required.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags to be added to the specified resource. Do not provide system tags. Required.

" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TemperatureUnit":{ - "type":"string", - "enum":[ - "FAHRENHEIT", - "CELSIUS" - ] - }, - "Text":{ - "type":"structure", - "required":[ - "Locale", - "Value" - ], - "members":{ - "Locale":{ - "shape":"Locale", - "documentation":"

The locale of the text message. Currently, en-US is supported.

" - }, - "Value":{ - "shape":"TextValue", - "documentation":"

The value of the text message.

" - } - }, - "documentation":"

The text message.

" - }, - "TextList":{ - "type":"list", - "member":{"shape":"Text"}, - "max":1 - }, - "TextValue":{ - "type":"string", - "max":4096, - "min":0, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" - }, - "TimeToLiveInSeconds":{ - "type":"integer", - "max":3600, - "min":1 - }, - "Timezone":{ - "type":"string", - "max":100, - "min":1 - }, - "TotalCount":{"type":"integer"}, - "TrustAnchor":{ - "type":"string", - "pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" - }, - "TrustAnchorList":{ - "type":"list", - "member":{"shape":"TrustAnchor"}, - "max":5, - "min":1 - }, - "UnauthorizedException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The caller has no permissions to operate on the resource involved in the API call.

", - "exception":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "Arn", - "TagKeys" - ], - "members":{ - "Arn":{ - "shape":"Arn", - "documentation":"

The ARN of the resource from which to remove metadata tags. Required.

" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"

The tags to be removed from the specified resource. Do not provide system tags. Required.

" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateAddressBookRequest":{ - "type":"structure", - "required":["AddressBookArn"], - "members":{ - "AddressBookArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room to update.

" - }, - "Name":{ - "shape":"AddressBookName", - "documentation":"

The updated name of the room.

" - }, - "Description":{ - "shape":"AddressBookDescription", - "documentation":"

The updated description of the room.

" - } - } - }, - "UpdateAddressBookResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateBusinessReportScheduleRequest":{ - "type":"structure", - "required":["ScheduleArn"], - "members":{ - "ScheduleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the business report schedule.

" - }, - "S3BucketName":{ - "shape":"CustomerS3BucketName", - "documentation":"

The S3 location of the output reports.

" - }, - "S3KeyPrefix":{ - "shape":"S3KeyPrefix", - "documentation":"

The S3 key where the report is delivered.

" - }, - "Format":{ - "shape":"BusinessReportFormat", - "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" - }, - "ScheduleName":{ - "shape":"BusinessReportScheduleName", - "documentation":"

The name identifier of the schedule.

" - }, - "Recurrence":{ - "shape":"BusinessReportRecurrence", - "documentation":"

The recurrence of the reports.

" - } - } - }, - "UpdateBusinessReportScheduleResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateConferenceProviderRequest":{ - "type":"structure", - "required":[ - "ConferenceProviderArn", - "ConferenceProviderType", - "MeetingSetting" - ], - "members":{ - "ConferenceProviderArn":{ - "shape":"Arn", - "documentation":"

The ARN of the conference provider.

" - }, - "ConferenceProviderType":{ - "shape":"ConferenceProviderType", - "documentation":"

The type of the conference provider.

" - }, - "IPDialIn":{ - "shape":"IPDialIn", - "documentation":"

The IP endpoint and protocol for calling.

" - }, - "PSTNDialIn":{ - "shape":"PSTNDialIn", - "documentation":"

The information for PSTN conferencing.

" - }, - "MeetingSetting":{ - "shape":"MeetingSetting", - "documentation":"

The meeting settings for the conference provider.

" - } - } - }, - "UpdateConferenceProviderResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateContactRequest":{ - "type":"structure", - "required":["ContactArn"], - "members":{ - "ContactArn":{ - "shape":"Arn", - "documentation":"

The ARN of the contact to update.

" - }, - "DisplayName":{ - "shape":"ContactName", - "documentation":"

The updated display name of the contact.

" - }, - "FirstName":{ - "shape":"ContactName", - "documentation":"

The updated first name of the contact.

" - }, - "LastName":{ - "shape":"ContactName", - "documentation":"

The updated last name of the contact.

" - }, - "PhoneNumber":{ - "shape":"RawPhoneNumber", - "documentation":"

The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" - }, - "PhoneNumbers":{ - "shape":"PhoneNumberList", - "documentation":"

The list of phone numbers for the contact.

" - }, - "SipAddresses":{ - "shape":"SipAddressList", - "documentation":"

The list of SIP addresses for the contact.

" - } - } - }, - "UpdateContactResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateDeviceRequest":{ - "type":"structure", - "members":{ - "DeviceArn":{ - "shape":"Arn", - "documentation":"

The ARN of the device to update. Required.

" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"

The updated device name. Required.

" - } - } - }, - "UpdateDeviceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateEndOfMeetingReminder":{ - "type":"structure", - "members":{ - "ReminderAtMinutes":{ - "shape":"EndOfMeetingReminderMinutesList", - "documentation":"

Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "ReminderType":{ - "shape":"EndOfMeetingReminderType", - "documentation":"

The type of sound that users hear during the end of meeting reminder.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether an end of meeting reminder is enabled or not.

" - } - }, - "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "UpdateGatewayGroupRequest":{ - "type":"structure", - "required":["GatewayGroupArn"], - "members":{ - "GatewayGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway group to update.

" - }, - "Name":{ - "shape":"GatewayGroupName", - "documentation":"

The updated name of the gateway group.

" - }, - "Description":{ - "shape":"GatewayGroupDescription", - "documentation":"

The updated description of the gateway group.

" - } - } - }, - "UpdateGatewayGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateGatewayRequest":{ - "type":"structure", - "required":["GatewayArn"], - "members":{ - "GatewayArn":{ - "shape":"Arn", - "documentation":"

The ARN of the gateway to update.

" - }, - "Name":{ - "shape":"GatewayName", - "documentation":"

The updated name of the gateway.

" - }, - "Description":{ - "shape":"GatewayDescription", - "documentation":"

The updated description of the gateway.

" - }, - "SoftwareVersion":{ - "shape":"GatewayVersion", - "documentation":"

The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

" - } - } - }, - "UpdateGatewayResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateInstantBooking":{ - "type":"structure", - "members":{ - "DurationInMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether instant booking is enabled or not.

" - } - }, - "documentation":"

Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.

" - }, - "UpdateMeetingRoomConfiguration":{ - "type":"structure", - "members":{ - "RoomUtilizationMetricsEnabled":{ - "shape":"Boolean", - "documentation":"

Whether room utilization metrics are enabled or not.

" - }, - "EndOfMeetingReminder":{ - "shape":"UpdateEndOfMeetingReminder", - "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - }, - "InstantBooking":{ - "shape":"UpdateInstantBooking", - "documentation":"

Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.

" - }, - "RequireCheckIn":{ - "shape":"UpdateRequireCheckIn", - "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" - }, - "ProactiveJoin":{"shape":"UpdateProactiveJoin"} - }, - "documentation":"

Updates meeting room settings of a room profile.

" - }, - "UpdateNetworkProfileRequest":{ - "type":"structure", - "required":["NetworkProfileArn"], - "members":{ - "NetworkProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the network profile associated with a device.

" - }, - "NetworkProfileName":{ - "shape":"NetworkProfileName", - "documentation":"

The name of the network profile associated with a device.

" - }, - "Description":{ - "shape":"NetworkProfileDescription", - "documentation":"

Detailed information about a device's network profile.

" - }, - "CurrentPassword":{ - "shape":"CurrentWiFiPassword", - "documentation":"

The current password of the Wi-Fi network.

" - }, - "NextPassword":{ - "shape":"NextWiFiPassword", - "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" - }, - "CertificateAuthorityArn":{ - "shape":"Arn", - "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" - }, - "TrustAnchors":{ - "shape":"TrustAnchorList", - "documentation":"

The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

" - } - } - }, - "UpdateNetworkProfileResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateProactiveJoin":{ - "type":"structure", - "required":["EnabledByMotion"], - "members":{ - "EnabledByMotion":{"shape":"Boolean"} - } - }, - "UpdateProfileRequest":{ - "type":"structure", - "members":{ - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room profile to update. Required.

" - }, - "ProfileName":{ - "shape":"ProfileName", - "documentation":"

The updated name for the room profile.

" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"

Sets the profile as default if selected. If this is missing, no update is done to the default status.

" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"

The updated timezone for the room profile.

" - }, - "Address":{ - "shape":"Address", - "documentation":"

The updated address for the room profile.

" - }, - "DistanceUnit":{ - "shape":"DistanceUnit", - "documentation":"

The updated distance unit for the room profile.

" - }, - "TemperatureUnit":{ - "shape":"TemperatureUnit", - "documentation":"

The updated temperature unit for the room profile.

" - }, - "WakeWord":{ - "shape":"WakeWord", - "documentation":"

The updated wake word for the room profile.

" - }, - "Locale":{ - "shape":"DeviceLocale", - "documentation":"

The updated locale for the room profile. (This is currently only available to a limited preview audience.)

" - }, - "SetupModeDisabled":{ - "shape":"Boolean", - "documentation":"

Whether the setup mode of the profile is enabled.

" - }, - "MaxVolumeLimit":{ - "shape":"MaxVolumeLimit", - "documentation":"

The updated maximum volume limit for the room profile.

" - }, - "PSTNEnabled":{ - "shape":"Boolean", - "documentation":"

Whether the PSTN setting of the room profile is enabled.

" - }, - "DataRetentionOptIn":{ - "shape":"Boolean", - "documentation":"

Whether data retention of the profile is enabled.

" - }, - "MeetingRoomConfiguration":{ - "shape":"UpdateMeetingRoomConfiguration", - "documentation":"

The updated meeting room settings of a room profile.

" - } - } - }, - "UpdateProfileResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateRequireCheckIn":{ - "type":"structure", - "members":{ - "ReleaseAfterMinutes":{ - "shape":"Minutes", - "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"

Whether require check in is enabled or not.

" - } - }, - "documentation":"

Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" - }, - "UpdateRoomRequest":{ - "type":"structure", - "members":{ - "RoomArn":{ - "shape":"Arn", - "documentation":"

The ARN of the room to update.

" - }, - "RoomName":{ - "shape":"RoomName", - "documentation":"

The updated name for the room.

" - }, - "Description":{ - "shape":"RoomDescription", - "documentation":"

The updated description for the room.

" - }, - "ProviderCalendarId":{ - "shape":"ProviderCalendarId", - "documentation":"

The updated provider calendar ARN for the room.

" - }, - "ProfileArn":{ - "shape":"Arn", - "documentation":"

The updated profile ARN for the room.

" - } - } - }, - "UpdateRoomResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateSkillGroupRequest":{ - "type":"structure", - "members":{ - "SkillGroupArn":{ - "shape":"Arn", - "documentation":"

The ARN of the skill group to update.

" - }, - "SkillGroupName":{ - "shape":"SkillGroupName", - "documentation":"

The updated name for the skill group.

" - }, - "Description":{ - "shape":"SkillGroupDescription", - "documentation":"

The updated description for the skill group.

" - } - } - }, - "UpdateSkillGroupResponse":{ - "type":"structure", - "members":{ - } - }, - "Url":{"type":"string"}, - "UserCode":{ - "type":"string", - "max":128, - "min":1 - }, - "UserData":{ - "type":"structure", - "members":{ - "UserArn":{ - "shape":"Arn", - "documentation":"

The ARN of a user.

" - }, - "FirstName":{ - "shape":"user_FirstName", - "documentation":"

The first name of a user.

" - }, - "LastName":{ - "shape":"user_LastName", - "documentation":"

The last name of a user.

" - }, - "Email":{ - "shape":"Email", - "documentation":"

The email of a user.

" - }, - "EnrollmentStatus":{ - "shape":"EnrollmentStatus", - "documentation":"

The enrollment status of a user.

" - }, - "EnrollmentId":{ - "shape":"EnrollmentId", - "documentation":"

The enrollment ARN of a user.

" - } - }, - "documentation":"

Information related to a user.

" - }, - "UserDataList":{ - "type":"list", - "member":{"shape":"UserData"} - }, - "UserId":{ - "type":"string", - "pattern":"amzn1\\.[A-Za-z0-9+-\\/=.]{1,300}" - }, - "Utterance":{"type":"string"}, - "Value":{ - "type":"string", - "min":1 - }, - "WakeWord":{ - "type":"string", - "enum":[ - "ALEXA", - "AMAZON", - "ECHO", - "COMPUTER" - ] - }, - "boolean":{"type":"boolean"}, - "user_FirstName":{ - "type":"string", - "max":30, - "min":0, - "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*" - }, - "user_LastName":{ - "type":"string", - "max":30, - "min":0, - "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*" - }, - "user_UserId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9@_+.-]*" - } - }, - "documentation":"

Alexa for Business has been retired and is no longer supported.

", - "deprecated":true, - "deprecatedMessage":"Alexa For Business is no longer supported" -} diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 243af2b794..3990171a5c 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -112,11 +112,6 @@ } }, "services" : { - "a4b" : { - "endpoints" : { - "us-east-1" : { } - } - }, "access-analyzer" : { "endpoints" : { "af-south-1" : { }, diff --git a/botocore/utils.py b/botocore/utils.py index e2c5c17a00..cba9a57c02 100644 --- a/botocore/utils.py +++ b/botocore/utils.py @@ -109,8 +109,6 @@ # id, we have to preserve compatibility. This maps the instances where either # is different than the transformed service id. EVENT_ALIASES = { - "a4b": "alexa-for-business", - "alexaforbusiness": "alexa-for-business", "api.mediatailor": "mediatailor", "api.pricing": "pricing", "api.sagemaker": "sagemaker", @@ -3570,7 +3568,6 @@ def is_s3express_bucket(bucket): # values are the transformed service IDs (lower case and hyphenated). CLIENT_NAME_TO_HYPHENIZED_SERVICE_ID_OVERRIDES = { # Actual service name we use -> Allowed computed service name. - 'alexaforbusiness': 'alexa-for-business', 'apigateway': 'api-gateway', 'application-autoscaling': 'application-auto-scaling', 'appmesh': 'app-mesh', diff --git a/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json b/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json deleted file mode 100644 index de7a21af1d..0000000000 --- a/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://a4b.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tests/functional/models/endpoints.json b/tests/functional/models/endpoints.json index 4b9b94a411..681dedc857 100644 --- a/tests/functional/models/endpoints.json +++ b/tests/functional/models/endpoints.json @@ -57,11 +57,6 @@ } }, "services" : { - "a4b" : { - "endpoints" : { - "us-east-1" : { } - } - }, "acm" : { "endpoints" : { "ap-northeast-1" : { }, diff --git a/tests/functional/test_event_alias.py b/tests/functional/test_event_alias.py index 9d0ec1730a..6ddcf513f8 100644 --- a/tests/functional/test_event_alias.py +++ b/tests/functional/test_event_alias.py @@ -8,10 +8,6 @@ SERVICES = { "acm": {"endpoint_prefix": "acm", "service_id": "acm"}, "acm-pca": {"endpoint_prefix": "acm-pca", "service_id": "acm-pca"}, - "alexaforbusiness": { - "endpoint_prefix": "a4b", - "service_id": "alexa-for-business", - }, "apigateway": { "endpoint_prefix": "apigateway", "service_id": "api-gateway", diff --git a/tests/functional/test_paginator_config.py b/tests/functional/test_paginator_config.py index 418a029da4..b6a9885904 100644 --- a/tests/functional/test_paginator_config.py +++ b/tests/functional/test_paginator_config.py @@ -32,11 +32,6 @@ # to reference all the extra output keys. Nothing should ever be added to this # list, it represents all the current released paginators that fail this test. KNOWN_EXTRA_OUTPUT_KEYS = [ - 'alexaforbusiness.SearchUsers.TotalCount', - 'alexaforbusiness.SearchProfiles.TotalCount', - 'alexaforbusiness.SearchSkillGroups.TotalCount', - 'alexaforbusiness.SearchDevices.TotalCount', - 'alexaforbusiness.SearchRooms.TotalCount', 'apigateway.GetApiKeys.warnings', 'apigateway.GetUsage.usagePlanId', 'apigateway.GetUsage.startDate', From e406696e4fad70edc16ef924ee55aff8a5a970c2 Mon Sep 17 00:00:00 2001 From: Kenneth Daily Date: Fri, 24 May 2024 12:11:24 -0700 Subject: [PATCH 3/7] Revert "Remove honeycode client following the service deprecation (#3186)" This reverts commit df5d06eec1beb3068046d1bc6fe32086b952c659. --- .../api-change-honeycode-76024.json | 5 - botocore/data/endpoints.json | 5 + .../2020-03-01/endpoint-rule-set-1.json | 314 +++ .../data/honeycode/2020-03-01/examples-1.json | 5 + .../honeycode/2020-03-01/paginators-1.json | 27 + .../2020-03-01/paginators-1.sdk-extras.json | 30 + .../data/honeycode/2020-03-01/service-2.json | 1833 +++++++++++++++++ .../honeycode/endpoint-tests-1.json | 327 +++ 8 files changed, 2541 insertions(+), 5 deletions(-) delete mode 100644 .changes/next-release/api-change-honeycode-76024.json create mode 100644 botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json create mode 100644 botocore/data/honeycode/2020-03-01/examples-1.json create mode 100644 botocore/data/honeycode/2020-03-01/paginators-1.json create mode 100644 botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json create mode 100644 botocore/data/honeycode/2020-03-01/service-2.json create mode 100644 tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json diff --git a/.changes/next-release/api-change-honeycode-76024.json b/.changes/next-release/api-change-honeycode-76024.json deleted file mode 100644 index 44d7760cb2..0000000000 --- a/.changes/next-release/api-change-honeycode-76024.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``honeycode``", - "description": "The honeycode client has been removed following the deprecation of the service." -} diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 3990171a5c..e6a451a7e7 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -8948,6 +8948,11 @@ "us-west-2" : { } } }, + "honeycode" : { + "endpoints" : { + "us-west-2" : { } + } + }, "iam" : { "endpoints" : { "aws-global" : { diff --git a/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json b/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000..e485bc8046 --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "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": [ + { + "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": [ + { + "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": [], + "endpoint": { + "url": "https://honeycode-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": [], + "endpoint": { + "url": "https://honeycode-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": [], + "endpoint": { + "url": "https://honeycode.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://honeycode.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/botocore/data/honeycode/2020-03-01/examples-1.json b/botocore/data/honeycode/2020-03-01/examples-1.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/honeycode/2020-03-01/paginators-1.json b/botocore/data/honeycode/2020-03-01/paginators-1.json new file mode 100644 index 0000000000..19ba884c5e --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/paginators-1.json @@ -0,0 +1,27 @@ +{ + "pagination": { + "ListTableColumns": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "tableColumns" + }, + "ListTableRows": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "rows" + }, + "ListTables": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tables" + }, + "QueryTableRows": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "rows" + } + } +} diff --git a/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json b/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json new file mode 100644 index 0000000000..bcdc190050 --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/paginators-1.sdk-extras.json @@ -0,0 +1,30 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "ListTableColumns": { + "non_aggregate_keys": [ + "workbookCursor" + ] + }, + "ListTableRows": { + "non_aggregate_keys": [ + "workbookCursor", + "columnIds", + "rowIdsNotFound" + ] + }, + "ListTables": { + "non_aggregate_keys": [ + "workbookCursor" + ] + }, + "QueryTableRows": { + "non_aggregate_keys": [ + "workbookCursor", + "columnIds" + ] + } + } + } +} \ No newline at end of file diff --git a/botocore/data/honeycode/2020-03-01/service-2.json b/botocore/data/honeycode/2020-03-01/service-2.json new file mode 100644 index 0000000000..74c726cfe4 --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/service-2.json @@ -0,0 +1,1833 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-03-01", + "endpointPrefix":"honeycode", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Honeycode", + "serviceFullName":"Amazon Honeycode", + "serviceId":"Honeycode", + "signatureVersion":"v4", + "signingName":"honeycode", + "uid":"honeycode-2020-03-01" + }, + "operations":{ + "BatchCreateTableRows":{ + "name":"BatchCreateTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchcreate" + }, + "input":{"shape":"BatchCreateTableRowsRequest"}, + "output":{"shape":"BatchCreateTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

" + }, + "BatchDeleteTableRows":{ + "name":"BatchDeleteTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchdelete" + }, + "input":{"shape":"BatchDeleteTableRowsRequest"}, + "output":{"shape":"BatchDeleteTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

" + }, + "BatchUpdateTableRows":{ + "name":"BatchUpdateTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchupdate" + }, + "input":{"shape":"BatchUpdateTableRowsRequest"}, + "output":{"shape":"BatchUpdateTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (\"\").

" + }, + "BatchUpsertTableRows":{ + "name":"BatchUpsertTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/batchupsert" + }, + "input":{"shape":"BatchUpsertTableRowsRequest"}, + "output":{"shape":"BatchUpsertTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string (\"\").

" + }, + "DescribeTableDataImportJob":{ + "name":"DescribeTableDataImportJob", + "http":{ + "method":"GET", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/import/{jobId}" + }, + "input":{"shape":"DescribeTableDataImportJobRequest"}, + "output":{"shape":"DescribeTableDataImportJobResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

" + }, + "GetScreenData":{ + "name":"GetScreenData", + "http":{ + "method":"POST", + "requestUri":"/screendata" + }, + "input":{"shape":"GetScreenDataRequest"}, + "output":{"shape":"GetScreenDataResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

" + }, + "InvokeScreenAutomation":{ + "name":"InvokeScreenAutomation", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}" + }, + "input":{"shape":"InvokeScreenAutomationRequest"}, + "output":{"shape":"InvokeScreenAutomationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"AutomationExecutionException"}, + {"shape":"AutomationExecutionTimeoutException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

" + }, + "ListTableColumns":{ + "name":"ListTableColumns", + "http":{ + "method":"GET", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/columns" + }, + "input":{"shape":"ListTableColumnsRequest"}, + "output":{"shape":"ListTableColumnsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

" + }, + "ListTableRows":{ + "name":"ListTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/list" + }, + "input":{"shape":"ListTableRowsRequest"}, + "output":{"shape":"ListTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ValidationException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

" + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"GET", + "requestUri":"/workbooks/{workbookId}/tables" + }, + "input":{"shape":"ListTablesRequest"}, + "output":{"shape":"ListTablesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The ListTables API allows you to retrieve a list of all the tables in a workbook.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The ListTagsForResource API allows you to return a resource's tags.

" + }, + "QueryTableRows":{ + "name":"QueryTableRows", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/rows/query" + }, + "input":{"shape":"QueryTableRowsRequest"}, + "output":{"shape":"QueryTableRowsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

" + }, + "StartTableDataImportJob":{ + "name":"StartTableDataImportJob", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/tables/{tableId}/import" + }, + "input":{"shape":"StartTableDataImportJobRequest"}, + "output":{"shape":"StartTableDataImportJobResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AutomationExecutionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The automation execution did not end successfully.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AutomationExecutionTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The automation execution timed out.

", + "error":{ + "httpStatusCode":504, + "senderFault":true + }, + "exception":true + }, + "AwsUserArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "BatchCreateTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "rowsToCreate" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook where the new rows are being added.

If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table where the new rows are being added.

If a table with the specified ID could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "rowsToCreate":{ + "shape":"CreateRowDataList", + "documentation":"

The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "BatchCreateTableRowsResult":{ + "type":"structure", + "required":[ + "workbookCursor", + "createdRows" + ], + "members":{ + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after adding the new rows at the end of the table.

" + }, + "createdRows":{ + "shape":"CreatedRowsMap", + "documentation":"

The map of batch item id to the row id that was created for that item.

" + }, + "failedBatchItems":{ + "shape":"FailedBatchItems", + "documentation":"

The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.

" + } + } + }, + "BatchDeleteTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "rowIds" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook where the rows are being deleted.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table where the rows are being deleted.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "rowIds":{ + "shape":"RowIdList", + "documentation":"

The list of row ids to delete from the table. You need to specify at least one row id in this list.

Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the delete action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "BatchDeleteTableRowsResult":{ + "type":"structure", + "required":["workbookCursor"], + "members":{ + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after deleting the rows from the table.

" + }, + "failedBatchItems":{ + "shape":"FailedBatchItems", + "documentation":"

The list of row ids in the request that could not be deleted from the table. Each element in this list contains one row id from the request that could not be deleted along with the reason why that item could not be deleted.

" + } + } + }, + "BatchErrorMessage":{ + "type":"string", + "pattern":"^(?!\\s*$).+" + }, + "BatchItemId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^(?!\\s*$).+" + }, + "BatchUpdateTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "rowsToUpdate" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook where the rows are being updated.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table where the rows are being updated.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "rowsToUpdate":{ + "shape":"UpdateRowDataList", + "documentation":"

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "BatchUpdateTableRowsResult":{ + "type":"structure", + "required":["workbookCursor"], + "members":{ + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after adding the new rows at the end of the table.

" + }, + "failedBatchItems":{ + "shape":"FailedBatchItems", + "documentation":"

The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.

" + } + } + }, + "BatchUpsertTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "rowsToUpsert" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook where the rows are being upserted.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table where the rows are being upserted.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "rowsToUpsert":{ + "shape":"UpsertRowDataList", + "documentation":"

The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "BatchUpsertTableRowsResult":{ + "type":"structure", + "required":[ + "rows", + "workbookCursor" + ], + "members":{ + "rows":{ + "shape":"UpsertRowsResultMap", + "documentation":"

A map with the batch item id as the key and the result of the upsert operation as the value. The result of the upsert operation specifies whether existing rows were updated or a new row was appended, along with the list of row ids that were affected.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after updating or appending rows in the table.

" + }, + "failedBatchItems":{ + "shape":"FailedBatchItems", + "documentation":"

The list of batch items in the request that could not be updated or appended in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated or appended.

" + } + } + }, + "Cell":{ + "type":"structure", + "members":{ + "formula":{ + "shape":"Formula", + "documentation":"

The formula contained in the cell. This field is empty if a cell does not have a formula.

" + }, + "format":{ + "shape":"Format", + "documentation":"

The format of the cell. If this field is empty, then the format is either not specified in the workbook or the format is set to AUTO.

" + }, + "rawValue":{ + "shape":"RawValue", + "documentation":"

The raw value of the data contained in the cell. The raw value depends on the format of the data in the cell. However the attribute in the API return value is always a string containing the raw value.

Cells with format DATE, DATE_TIME or TIME have the raw value as a floating point number where the whole number represents the number of days since 1/1/1900 and the fractional part represents the fraction of the day since midnight. For example, a cell with date 11/3/2020 has the raw value \"44138\". A cell with the time 9:00 AM has the raw value \"0.375\" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value \"44138.375\". Notice that even though the raw value is a number in all three cases, it is still represented as a string.

Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw value of the data as the number representing the data being displayed. For example, the number 1.325 with two decimal places in the format will have it's raw value as \"1.325\" and formatted value as \"1.33\". A currency value for $10 will have the raw value as \"10\" and formatted value as \"$10.00\". A value representing 20% with two decimal places in the format will have its raw value as \"0.2\" and the formatted value as \"20.00%\". An accounting value of -$25 will have \"-25\" as the raw value and \"$ (25.00)\" as the formatted value.

Cells with format TEXT will have the raw text as the raw value. For example, a cell with text \"John Smith\" will have \"John Smith\" as both the raw value and the formatted value.

Cells with format CONTACT will have the name of the contact as a formatted value and the email address of the contact as the raw value. For example, a contact for John Smith will have \"John Smith\" as the formatted value and \"john.smith@example.com\" as the raw value.

Cells with format ROWLINK (aka picklist) will have the first column of the linked row as the formatted value and the row id of the linked row as the raw value. For example, a cell containing a picklist to a table that displays task status might have \"Completed\" as the formatted value and \"row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03\" as the raw value.

Cells with format ROWSET (aka multi-select or multi-record picklist) will by default have the first column of each of the linked rows as the formatted value in the list, and the rowset id of the linked rows as the raw value. For example, a cell containing a multi-select picklist to a table that contains items might have \"Item A\", \"Item B\" in the formatted value list and \"rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/ [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]\" as the raw value.

Cells with format ATTACHMENT will have the name of the attachment as the formatted value and the attachment id as the raw value. For example, a cell containing an attachment named \"image.jpeg\" will have \"image.jpeg\" as the formatted value and \"attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03\" as the raw value.

Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no auto-detected format, the raw and formatted values will be the same as the data in the cell.

" + }, + "formattedValue":{ + "shape":"FormattedValue", + "documentation":"

The formatted value of the cell. This is the value that you see displayed in the cell in the UI.

Note that the formatted value of a cell is always represented as a string irrespective of the data that is stored in the cell. For example, if a cell contains a date, the formatted value of the cell is the string representation of the formatted date being shown in the cell in the UI. See details in the rawValue field below for how cells of different formats will have different raw and formatted values.

" + }, + "formattedValues":{ + "shape":"FormattedValuesList", + "documentation":"

A list of formatted values of the cell. This field is only returned when the cell is ROWSET format (aka multi-select or multi-record picklist). Values in the list are always represented as strings. The formattedValue field will be empty if this field is returned.

" + } + }, + "documentation":"

An object that represents a single cell in a table.

", + "sensitive":true + }, + "CellInput":{ + "type":"structure", + "members":{ + "fact":{ + "shape":"Fact", + "documentation":"

Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.

" + }, + "facts":{ + "shape":"FactList", + "documentation":"

A list representing the values that are entered into a ROWSET cell. Facts list can have either only values or rowIDs, and rowIDs should from the same table.

" + } + }, + "documentation":"

CellInput object contains the data needed to create or update cells in a table.

CellInput object has only a facts field or a fact field, but not both. A 400 bad request will be thrown if both fact and facts field are present.

" + }, + "Cells":{ + "type":"list", + "member":{"shape":"Cell"} + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":32, + "pattern":"^(?!\\s*$).+" + }, + "ColumnMetadata":{ + "type":"structure", + "required":[ + "name", + "format" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the column.

" + }, + "format":{ + "shape":"Format", + "documentation":"

The format of the column.

" + } + }, + "documentation":"

Metadata for column in the table.

" + }, + "CreateRowData":{ + "type":"structure", + "required":[ + "batchItemId", + "cellsToCreate" + ], + "members":{ + "batchItemId":{ + "shape":"BatchItemId", + "documentation":"

An external identifier that represents the single row that is being created as part of the BatchCreateTableRows request. This can be any string that you can use to identify the row in the request. The BatchCreateTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

" + }, + "cellsToCreate":{ + "shape":"RowDataInput", + "documentation":"

A map representing the cells to create in the new row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" + } + }, + "documentation":"

Data needed to create a single row in a table as part of the BatchCreateTableRows request.

" + }, + "CreateRowDataList":{ + "type":"list", + "member":{"shape":"CreateRowData"}, + "max":100, + "min":1 + }, + "CreatedRowsMap":{ + "type":"map", + "key":{"shape":"BatchItemId"}, + "value":{"shape":"RowId"} + }, + "DataItem":{ + "type":"structure", + "members":{ + "overrideFormat":{ + "shape":"Format", + "documentation":"

The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table.

" + }, + "rawValue":{ + "shape":"RawValue", + "documentation":"

The raw value of the data. e.g. jsmith@example.com

" + }, + "formattedValue":{ + "shape":"FormattedValue", + "documentation":"

The formatted value of the data. e.g. John Smith.

" + } + }, + "documentation":"

The data in a particular data cell defined on the screen.

", + "sensitive":true + }, + "DataItems":{ + "type":"list", + "member":{"shape":"DataItem"} + }, + "DelimitedTextDelimiter":{ + "type":"string", + "max":1, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]?$" + }, + "DelimitedTextImportOptions":{ + "type":"structure", + "required":["delimiter"], + "members":{ + "delimiter":{ + "shape":"DelimitedTextDelimiter", + "documentation":"

The delimiter to use for separating columns in a single row of the input.

" + }, + "hasHeaderRow":{ + "shape":"HasHeaderRow", + "documentation":"

Indicates whether the input file has a header row at the top containing the column names.

" + }, + "ignoreEmptyRows":{ + "shape":"IgnoreEmptyRows", + "documentation":"

A parameter to indicate whether empty rows should be ignored or be included in the import.

" + }, + "dataCharacterEncoding":{ + "shape":"ImportDataCharacterEncoding", + "documentation":"

The encoding of the data in the input file.

" + } + }, + "documentation":"

An object that contains the options relating to parsing delimited text as part of an import request.

" + }, + "DescribeTableDataImportJobRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "jobId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook into which data was imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table into which data was imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The ID of the job that was returned by the StartTableDataImportJob request.

If a job with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"jobId" + } + } + }, + "DescribeTableDataImportJobResult":{ + "type":"structure", + "required":[ + "jobStatus", + "message", + "jobMetadata" + ], + "members":{ + "jobStatus":{ + "shape":"TableDataImportJobStatus", + "documentation":"

The current status of the import job.

" + }, + "message":{ + "shape":"TableDataImportJobMessage", + "documentation":"

A message providing more details about the current status of the import job.

" + }, + "jobMetadata":{ + "shape":"TableDataImportJobMetadata", + "documentation":"

The metadata about the job that was submitted for import.

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

If job status is failed, error code to understand reason for the failure.

" + } + } + }, + "DestinationOptions":{ + "type":"structure", + "members":{ + "columnMap":{ + "shape":"ImportColumnMap", + "documentation":"

A map of the column id to the import properties for each column.

" + } + }, + "documentation":"

An object that contains the options relating to the destination of the import request.

" + }, + "Email":{ + "type":"string", + "max":254, + "min":3, + "pattern":"^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$", + "sensitive":true + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "ACCESS_DENIED", + "INVALID_URL_ERROR", + "INVALID_IMPORT_OPTIONS_ERROR", + "INVALID_TABLE_ID_ERROR", + "INVALID_TABLE_COLUMN_ID_ERROR", + "TABLE_NOT_FOUND_ERROR", + "FILE_EMPTY_ERROR", + "INVALID_FILE_TYPE_ERROR", + "FILE_PARSING_ERROR", + "FILE_SIZE_LIMIT_ERROR", + "FILE_NOT_FOUND_ERROR", + "UNKNOWN_ERROR", + "RESOURCE_NOT_FOUND_ERROR", + "SYSTEM_LIMIT_ERROR" + ] + }, + "ErrorMessage":{"type":"string"}, + "Fact":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"[\\s\\S]*", + "sensitive":true + }, + "FactList":{ + "type":"list", + "member":{"shape":"Fact"}, + "max":220, + "min":0 + }, + "FailedBatchItem":{ + "type":"structure", + "required":[ + "id", + "errorMessage" + ], + "members":{ + "id":{ + "shape":"BatchItemId", + "documentation":"

The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

" + }, + "errorMessage":{ + "shape":"BatchErrorMessage", + "documentation":"

The error message that indicates why the batch item failed.

" + } + }, + "documentation":"

A single item in a batch that failed to perform the intended action because of an error preventing it from succeeding.

" + }, + "FailedBatchItems":{ + "type":"list", + "member":{"shape":"FailedBatchItem"}, + "max":100, + "min":0 + }, + "Filter":{ + "type":"structure", + "required":["formula"], + "members":{ + "formula":{ + "shape":"Formula", + "documentation":"

A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.

" + }, + "contextRowId":{ + "shape":"RowId", + "documentation":"

The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.

" + } + }, + "documentation":"

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

" + }, + "Format":{ + "type":"string", + "enum":[ + "AUTO", + "NUMBER", + "CURRENCY", + "DATE", + "TIME", + "DATE_TIME", + "PERCENTAGE", + "TEXT", + "ACCOUNTING", + "CONTACT", + "ROWLINK", + "ROWSET" + ] + }, + "FormattedValue":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"[\\s\\S]*" + }, + "FormattedValuesList":{ + "type":"list", + "member":{"shape":"FormattedValue"}, + "max":220, + "min":0 + }, + "Formula":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"^=.*", + "sensitive":true + }, + "GetScreenDataRequest":{ + "type":"structure", + "required":[ + "workbookId", + "appId", + "screenId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the screen.

" + }, + "appId":{ + "shape":"ResourceId", + "documentation":"

The ID of the app that contains the screen.

" + }, + "screenId":{ + "shape":"ResourceId", + "documentation":"

The ID of the screen.

" + }, + "variables":{ + "shape":"VariableValueMap", + "documentation":"

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" + } + } + }, + "GetScreenDataResult":{ + "type":"structure", + "required":[ + "results", + "workbookCursor" + ], + "members":{ + "results":{ + "shape":"ResultSetMap", + "documentation":"

A map of all the rows on the screen keyed by block name.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.

" + } + } + }, + "HasHeaderRow":{"type":"boolean"}, + "IgnoreEmptyRows":{"type":"boolean"}, + "ImportColumnMap":{ + "type":"map", + "key":{"shape":"ResourceId"}, + "value":{"shape":"SourceDataColumnProperties"}, + "max":100 + }, + "ImportDataCharacterEncoding":{ + "type":"string", + "enum":[ + "UTF-8", + "US-ASCII", + "ISO-8859-1", + "UTF-16BE", + "UTF-16LE", + "UTF-16" + ] + }, + "ImportDataSource":{ + "type":"structure", + "required":["dataSourceConfig"], + "members":{ + "dataSourceConfig":{ + "shape":"ImportDataSourceConfig", + "documentation":"

The configuration parameters for the data source of the import

" + } + }, + "documentation":"

An object that has details about the source of the data that was submitted for import.

" + }, + "ImportDataSourceConfig":{ + "type":"structure", + "members":{ + "dataSourceUrl":{ + "shape":"SecureURL", + "documentation":"

The URL from which source data will be downloaded for the import request.

" + } + }, + "documentation":"

An object that contains the configuration parameters for the data source of an import request.

" + }, + "ImportJobSubmitter":{ + "type":"structure", + "members":{ + "email":{ + "shape":"Email", + "documentation":"

The email id of the submitter of the import job, if available.

" + }, + "userArn":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user ARN of the submitter of the import job, if available.

" + } + }, + "documentation":"

An object that contains the attributes of the submitter of the import job.

" + }, + "ImportOptions":{ + "type":"structure", + "members":{ + "destinationOptions":{ + "shape":"DestinationOptions", + "documentation":"

Options relating to the destination of the import request.

" + }, + "delimitedTextOptions":{ + "shape":"DelimitedTextImportOptions", + "documentation":"

Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.

" + } + }, + "documentation":"

An object that contains the options specified by the sumitter of the import request.

" + }, + "ImportSourceDataFormat":{ + "type":"string", + "enum":["DELIMITED_TEXT"] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

There were unexpected errors from the server.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvokeScreenAutomationRequest":{ + "type":"structure", + "required":[ + "workbookId", + "appId", + "screenId", + "screenAutomationId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the screen automation.

", + "location":"uri", + "locationName":"workbookId" + }, + "appId":{ + "shape":"ResourceId", + "documentation":"

The ID of the app that contains the screen automation.

", + "location":"uri", + "locationName":"appId" + }, + "screenId":{ + "shape":"ResourceId", + "documentation":"

The ID of the screen that contains the screen automation.

", + "location":"uri", + "locationName":"screenId" + }, + "screenAutomationId":{ + "shape":"ResourceId", + "documentation":"

The ID of the automation action to be performed.

", + "location":"uri", + "locationName":"automationId" + }, + "variables":{ + "shape":"VariableValueMap", + "documentation":"

Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

" + }, + "rowId":{ + "shape":"RowId", + "documentation":"

The row ID for the automation if the automation is defined inside a block with source or list.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "InvokeScreenAutomationResult":{ + "type":"structure", + "required":["workbookCursor"], + "members":{ + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after performing the automation action.

" + } + } + }, + "JobId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" + }, + "ListTableColumnsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the table whose columns are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table whose columns are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListTableColumnsResult":{ + "type":"structure", + "required":["tableColumns"], + "members":{ + "tableColumns":{ + "shape":"TableColumns", + "documentation":"

The list of columns in the table.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + } + } + }, + "ListTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the table whose rows are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table whose rows are being retrieved.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "rowIds":{ + "shape":"RowIdList", + "documentation":"

This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of rows to return in each page of the results.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" + } + } + }, + "ListTableRowsResult":{ + "type":"structure", + "required":[ + "columnIds", + "rows", + "workbookCursor" + ], + "members":{ + "columnIds":{ + "shape":"ResourceIds", + "documentation":"

The list of columns in the table whose row data is returned in the result.

" + }, + "rows":{ + "shape":"TableRows", + "documentation":"

The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.

" + }, + "rowIdsNotFound":{ + "shape":"RowIdList", + "documentation":"

The list of row ids included in the request that were not found in the table.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + } + } + }, + "ListTablesRequest":{ + "type":"structure", + "required":["workbookId"], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook whose tables are being retrieved.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of tables to return in each page of the results.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListTablesResult":{ + "type":"structure", + "required":["tables"], + "members":{ + "tables":{ + "shape":"Tables", + "documentation":"

The list of tables in the workbook.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagsMap", + "documentation":"

The resource's tags.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "sensitive":true + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^(?!\\s*$).+" + }, + "QueryTableRowsRequest":{ + "type":"structure", + "required":[ + "workbookId", + "tableId", + "filterFormula" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook whose table rows are being queried.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "tableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table whose rows are being queried.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "filterFormula":{ + "shape":"Filter", + "documentation":"

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of rows to return in each page of the results.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" + } + } + }, + "QueryTableRowsResult":{ + "type":"structure", + "required":[ + "columnIds", + "rows", + "workbookCursor" + ], + "members":{ + "columnIds":{ + "shape":"ResourceIds", + "documentation":"

The list of columns in the table whose row data is returned in the result.

" + }, + "rows":{ + "shape":"TableRows", + "documentation":"

The list of rows in the table that match the query filter.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + } + } + }, + "RawValue":{ + "type":"string", + "max":32767, + "min":0, + "pattern":"[\\s\\S]*" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request timed out.

", + "error":{ + "httpStatusCode":504, + "senderFault":true + }, + "exception":true + }, + "ResourceArn":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^arn:aws:honeycode:.+:[0-9]{12}:.+:.+$" + }, + "ResourceId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "ResourceIds":{ + "type":"list", + "member":{"shape":"ResourceId"}, + "max":100, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResultHeader":{ + "type":"list", + "member":{"shape":"ColumnMetadata"} + }, + "ResultRow":{ + "type":"structure", + "required":["dataItems"], + "members":{ + "rowId":{ + "shape":"RowId", + "documentation":"

The ID for a particular row.

" + }, + "dataItems":{ + "shape":"DataItems", + "documentation":"

List of all the data cells in a row.

" + } + }, + "documentation":"

A single row in the ResultSet.

" + }, + "ResultRows":{ + "type":"list", + "member":{"shape":"ResultRow"} + }, + "ResultSet":{ + "type":"structure", + "required":[ + "headers", + "rows" + ], + "members":{ + "headers":{ + "shape":"ResultHeader", + "documentation":"

List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

For example, a task list that displays the task name, due date and assigned person might have headers [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

" + }, + "rows":{ + "shape":"ResultRows", + "documentation":"

List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

" + } + }, + "documentation":"

ResultSet contains the results of the request for a single block or list defined on the screen.

" + }, + "ResultSetMap":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"ResultSet"} + }, + "RowDataInput":{ + "type":"map", + "key":{"shape":"ResourceId"}, + "value":{"shape":"CellInput"}, + "max":100, + "min":1 + }, + "RowId":{ + "type":"string", + "max":77, + "min":77, + "pattern":"row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "RowIdList":{ + "type":"list", + "member":{"shape":"RowId"}, + "max":100, + "min":1 + }, + "SecureURL":{ + "type":"string", + "max":8000, + "min":1, + "pattern":"^https:\\/\\/[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$", + "sensitive":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request caused service quota to be breached.

", + "error":{"httpStatusCode":402}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Remote service is unreachable.

", + "error":{"httpStatusCode":503}, + "exception":true + }, + "SourceDataColumnIndex":{ + "type":"integer", + "min":1 + }, + "SourceDataColumnProperties":{ + "type":"structure", + "members":{ + "columnIndex":{ + "shape":"SourceDataColumnIndex", + "documentation":"

The index of the column in the input file.

" + } + }, + "documentation":"

An object that contains the properties for importing data to a specific column in a table.

" + }, + "StartTableDataImportJobRequest":{ + "type":"structure", + "required":[ + "workbookId", + "dataSource", + "dataFormat", + "destinationTableId", + "importOptions", + "clientRequestToken" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook where the rows are being imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"workbookId" + }, + "dataSource":{ + "shape":"ImportDataSource", + "documentation":"

The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

" + }, + "dataFormat":{ + "shape":"ImportSourceDataFormat", + "documentation":"

The format of the data that is being imported. Currently the only option supported is \"DELIMITED_TEXT\".

" + }, + "destinationTableId":{ + "shape":"ResourceId", + "documentation":"

The ID of the table where the rows are being imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

", + "location":"uri", + "locationName":"tableId" + }, + "importOptions":{ + "shape":"ImportOptions", + "documentation":"

The options for customizing this import request.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "StartTableDataImportJobResult":{ + "type":"structure", + "required":[ + "jobId", + "jobStatus" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.

" + }, + "jobStatus":{ + "shape":"TableDataImportJobStatus", + "documentation":"

The status of the import job immediately after submitting the request.

" + } + } + }, + "Table":{ + "type":"structure", + "members":{ + "tableId":{ + "shape":"ResourceId", + "documentation":"

The id of the table.

" + }, + "tableName":{ + "shape":"TableName", + "documentation":"

The name of the table.

" + } + }, + "documentation":"

An object representing the properties of a table in a workbook.

" + }, + "TableColumn":{ + "type":"structure", + "members":{ + "tableColumnId":{ + "shape":"ResourceId", + "documentation":"

The id of the column in the table.

" + }, + "tableColumnName":{ + "shape":"TableColumnName", + "documentation":"

The name of the column in the table.

" + }, + "format":{ + "shape":"Format", + "documentation":"

The column level format that is applied in the table. An empty value in this field means that the column format is the default value 'AUTO'.

" + } + }, + "documentation":"

An object that contains attributes about a single column in a table

" + }, + "TableColumnName":{"type":"string"}, + "TableColumns":{ + "type":"list", + "member":{"shape":"TableColumn"} + }, + "TableDataImportJobMessage":{"type":"string"}, + "TableDataImportJobMetadata":{ + "type":"structure", + "required":[ + "submitter", + "submitTime", + "importOptions", + "dataSource" + ], + "members":{ + "submitter":{ + "shape":"ImportJobSubmitter", + "documentation":"

Details about the submitter of the import request.

" + }, + "submitTime":{ + "shape":"TimestampInMillis", + "documentation":"

The timestamp when the job was submitted for import.

" + }, + "importOptions":{ + "shape":"ImportOptions", + "documentation":"

The options that was specified at the time of submitting the import request.

" + }, + "dataSource":{ + "shape":"ImportDataSource", + "documentation":"

The source of the data that was submitted for import.

" + } + }, + "documentation":"

The metadata associated with the table data import job that was submitted.

" + }, + "TableDataImportJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "TableName":{"type":"string"}, + "TableRow":{ + "type":"structure", + "required":[ + "rowId", + "cells" + ], + "members":{ + "rowId":{ + "shape":"RowId", + "documentation":"

The id of the row in the table.

" + }, + "cells":{ + "shape":"Cells", + "documentation":"

A list of cells in the table row. The cells appear in the same order as the columns of the table.

" + } + }, + "documentation":"

An object that contains attributes about a single row in a table

" + }, + "TableRows":{ + "type":"list", + "member":{"shape":"TableRow"} + }, + "Tables":{ + "type":"list", + "member":{"shape":"Table"} + }, + "TagKey":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" + }, + "TagKeysList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "documentation":"

A list of tag keys

", + "max":100 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"

A list of tags to apply to the resource.

" + } + } + }, + "TagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[^\\n\\r\\x00\\x08\\x0B\\x0C\\x0E\\x1F]*$" + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "documentation":"

A string to string map representing tags

", + "max":100 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Tps(transactions per second) rate reached.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimestampInMillis":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeysList", + "documentation":"

A list of tag keys to remove from the resource.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateRowData":{ + "type":"structure", + "required":[ + "rowId", + "cellsToUpdate" + ], + "members":{ + "rowId":{ + "shape":"RowId", + "documentation":"

The id of the row that needs to be updated.

" + }, + "cellsToUpdate":{ + "shape":"RowDataInput", + "documentation":"

A map representing the cells to update in the given row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" + } + }, + "documentation":"

Data needed to create a single row in a table as part of the BatchCreateTableRows request.

" + }, + "UpdateRowDataList":{ + "type":"list", + "member":{"shape":"UpdateRowData"}, + "max":100, + "min":1 + }, + "UpsertAction":{ + "type":"string", + "enum":[ + "UPDATED", + "APPENDED" + ] + }, + "UpsertRowData":{ + "type":"structure", + "required":[ + "batchItemId", + "filter", + "cellsToUpdate" + ], + "members":{ + "batchItemId":{ + "shape":"BatchItemId", + "documentation":"

An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

" + }, + "filter":{ + "shape":"Filter", + "documentation":"

The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

" + }, + "cellsToUpdate":{ + "shape":"RowDataInput", + "documentation":"

A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

" + } + }, + "documentation":"

Data needed to upsert rows in a table as part of a single item in the BatchUpsertTableRows request.

" + }, + "UpsertRowDataList":{ + "type":"list", + "member":{"shape":"UpsertRowData"} + }, + "UpsertRowsResult":{ + "type":"structure", + "required":[ + "rowIds", + "upsertAction" + ], + "members":{ + "rowIds":{ + "shape":"RowIdList", + "documentation":"

The list of row ids that were changed as part of an upsert row operation. If the upsert resulted in an update, this list could potentially contain multiple rows that matched the filter and hence got updated. If the upsert resulted in an append, this list would only have the single row that was appended.

" + }, + "upsertAction":{ + "shape":"UpsertAction", + "documentation":"

The result of the upsert action.

" + } + }, + "documentation":"

An object that represents the result of a single upsert row request.

" + }, + "UpsertRowsResultMap":{ + "type":"map", + "key":{"shape":"BatchItemId"}, + "value":{"shape":"UpsertRowsResult"} + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Request is invalid. The message in the response contains details on why the request is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VariableName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^(?!\\s*$).+", + "sensitive":true + }, + "VariableValue":{ + "type":"structure", + "required":["rawValue"], + "members":{ + "rawValue":{ + "shape":"RawValue", + "documentation":"

Raw value of the variable.

" + } + }, + "documentation":"

The input variables to the app to be used by the InvokeScreenAutomation action request.

", + "sensitive":true + }, + "VariableValueMap":{ + "type":"map", + "key":{"shape":"VariableName"}, + "value":{"shape":"VariableValue"}, + "sensitive":true + }, + "WorkbookCursor":{"type":"long"} + }, + "documentation":"

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

" +} diff --git a/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json b/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json new file mode 100644 index 0000000000..bfec834a71 --- /dev/null +++ b/tests/functional/endpoint-rules/honeycode/endpoint-tests-1.json @@ -0,0 +1,327 @@ +{ + "testCases": [ + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://honeycode.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file From 0995d66bb9dbe80c68a7d1c4eef79b79e0cb26b7 Mon Sep 17 00:00:00 2001 From: Kenneth Daily Date: Fri, 24 May 2024 12:11:48 -0700 Subject: [PATCH 4/7] Revert "Remove alexaforbusiness client following the service deprecation (#3187)" This reverts commit 864f4318b5e07c765bda2bf9f6fab62f07655aa3. --- .../api-change-alexaforbusiness-18876.json | 5 - .../2017-11-09/endpoint-rule-set-1.json | 314 + .../2017-11-09/examples-1.json | 5 + .../2017-11-09/paginators-1.json | 82 + .../2017-11-09/service-2.json | 6318 +++++++++++++++++ botocore/data/endpoints.json | 5 + botocore/utils.py | 3 + .../alexaforbusiness/endpoint-tests-1.json | 314 + tests/functional/models/endpoints.json | 5 + tests/functional/test_event_alias.py | 4 + tests/functional/test_paginator_config.py | 5 + 11 files changed, 7055 insertions(+), 5 deletions(-) delete mode 100644 .changes/next-release/api-change-alexaforbusiness-18876.json create mode 100644 botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json create mode 100644 botocore/data/alexaforbusiness/2017-11-09/examples-1.json create mode 100644 botocore/data/alexaforbusiness/2017-11-09/paginators-1.json create mode 100644 botocore/data/alexaforbusiness/2017-11-09/service-2.json create mode 100644 tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json diff --git a/.changes/next-release/api-change-alexaforbusiness-18876.json b/.changes/next-release/api-change-alexaforbusiness-18876.json deleted file mode 100644 index b6b8cdbe60..0000000000 --- a/.changes/next-release/api-change-alexaforbusiness-18876.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``alexaforbusiness``", - "description": "The alexaforbusiness client has been removed following the deprecation of the service." -} diff --git a/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json b/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json new file mode 100644 index 0000000000..d8065b9dc0 --- /dev/null +++ b/botocore/data/alexaforbusiness/2017-11-09/endpoint-rule-set-1.json @@ -0,0 +1,314 @@ +{ + "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": [ + { + "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": [ + { + "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": [], + "endpoint": { + "url": "https://a4b-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": [], + "endpoint": { + "url": "https://a4b-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": [], + "endpoint": { + "url": "https://a4b.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://a4b.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] +} \ No newline at end of file diff --git a/botocore/data/alexaforbusiness/2017-11-09/examples-1.json b/botocore/data/alexaforbusiness/2017-11-09/examples-1.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/botocore/data/alexaforbusiness/2017-11-09/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json b/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json new file mode 100644 index 0000000000..ced5de2f7e --- /dev/null +++ b/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json @@ -0,0 +1,82 @@ +{ + "pagination": { + "ListSkills": { + "result_key": "SkillSummaries", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchUsers": { + "result_key": "Users", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "result_key": "Tags", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchProfiles": { + "result_key": "Profiles", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchSkillGroups": { + "result_key": "SkillGroups", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchDevices": { + "result_key": "Devices", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchRooms": { + "result_key": "Rooms", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBusinessReportSchedules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BusinessReportSchedules" + }, + "ListConferenceProviders": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ConferenceProviders" + }, + "ListDeviceEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DeviceEvents" + }, + "ListSkillsStoreCategories": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CategoryList" + }, + "ListSkillsStoreSkillsByCategory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SkillsStoreSkills" + }, + "ListSmartHomeAppliances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SmartHomeAppliances" + } + } +} diff --git a/botocore/data/alexaforbusiness/2017-11-09/service-2.json b/botocore/data/alexaforbusiness/2017-11-09/service-2.json new file mode 100644 index 0000000000..9aa7a8702d --- /dev/null +++ b/botocore/data/alexaforbusiness/2017-11-09/service-2.json @@ -0,0 +1,6318 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-09", + "endpointPrefix":"a4b", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Alexa For Business", + "serviceId":"Alexa For Business", + "signatureVersion":"v4", + "targetPrefix":"AlexaForBusiness", + "uid":"alexaforbusiness-2017-11-09" + }, + "operations":{ + "ApproveSkill":{ + "name":"ApproveSkill", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApproveSkillRequest"}, + "output":{"shape":"ApproveSkillResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateContactWithAddressBook":{ + "name":"AssociateContactWithAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateContactWithAddressBookRequest"}, + "output":{"shape":"AssociateContactWithAddressBookResponse"}, + "errors":[ + {"shape":"LimitExceededException"} + ], + "documentation":"

Associates a contact with a given address book.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateDeviceWithNetworkProfile":{ + "name":"AssociateDeviceWithNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDeviceWithNetworkProfileRequest"}, + "output":{"shape":"AssociateDeviceWithNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Associates a device with the specified network profile.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateDeviceWithRoom":{ + "name":"AssociateDeviceWithRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDeviceWithRoomRequest"}, + "output":{"shape":"AssociateDeviceWithRoomResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateSkillGroupWithRoom":{ + "name":"AssociateSkillGroupWithRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillGroupWithRoomRequest"}, + "output":{"shape":"AssociateSkillGroupWithRoomResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateSkillWithSkillGroup":{ + "name":"AssociateSkillWithSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillWithSkillGroupRequest"}, + "output":{"shape":"AssociateSkillWithSkillGroupResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"SkillNotLinkedException"} + ], + "documentation":"

Associates a skill with a skill group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "AssociateSkillWithUsers":{ + "name":"AssociateSkillWithUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillWithUsersRequest"}, + "output":{"shape":"AssociateSkillWithUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Makes a private skill available for enrolled users to enable on their devices.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateAddressBook":{ + "name":"CreateAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddressBookRequest"}, + "output":{"shape":"CreateAddressBookResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an address book with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateBusinessReportSchedule":{ + "name":"CreateBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBusinessReportScheduleRequest"}, + "output":{"shape":"CreateBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateConferenceProvider":{ + "name":"CreateConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConferenceProviderRequest"}, + "output":{"shape":"CreateConferenceProviderResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Adds a new conference provider under the user's AWS account.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateContact":{ + "name":"CreateContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateContactRequest"}, + "output":{"shape":"CreateContactResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a contact with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateGatewayGroup":{ + "name":"CreateGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGatewayGroupRequest"}, + "output":{"shape":"CreateGatewayGroupResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a gateway group with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateNetworkProfile":{ + "name":"CreateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkProfileRequest"}, + "output":{"shape":"CreateNetworkProfileResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"}, + {"shape":"InvalidServiceLinkedRoleStateException"} + ], + "documentation":"

Creates a network profile with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateProfile":{ + "name":"CreateProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProfileRequest"}, + "output":{"shape":"CreateProfileResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a new room profile with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateRoom":{ + "name":"CreateRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRoomRequest"}, + "output":{"shape":"CreateRoomResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a room with the specified details.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateSkillGroup":{ + "name":"CreateSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSkillGroupRequest"}, + "output":{"shape":"CreateSkillGroupResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a skill group with a specified name and description.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a user.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteAddressBook":{ + "name":"DeleteAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAddressBookRequest"}, + "output":{"shape":"DeleteAddressBookResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes an address book by the address book ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteBusinessReportSchedule":{ + "name":"DeleteBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBusinessReportScheduleRequest"}, + "output":{"shape":"DeleteBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the recurring report delivery schedule with the specified schedule ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteConferenceProvider":{ + "name":"DeleteConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConferenceProviderRequest"}, + "output":{"shape":"DeleteConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes a conference provider.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteContact":{ + "name":"DeleteContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteContactRequest"}, + "output":{"shape":"DeleteContactResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a contact by the contact ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteDevice":{ + "name":"DeleteDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeviceRequest"}, + "output":{"shape":"DeleteDeviceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"} + ], + "documentation":"

Removes a device from Alexa For Business.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteDeviceUsageData":{ + "name":"DeleteDeviceUsageData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeviceUsageDataRequest"}, + "output":{"shape":"DeleteDeviceUsageDataResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DeviceNotRegisteredException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteGatewayGroup":{ + "name":"DeleteGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGatewayGroupRequest"}, + "output":{"shape":"DeleteGatewayGroupResponse"}, + "errors":[ + {"shape":"ResourceAssociatedException"} + ], + "documentation":"

Deletes a gateway group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteNetworkProfile":{ + "name":"DeleteNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkProfileRequest"}, + "output":{"shape":"DeleteNetworkProfileResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes a network profile by the network profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteProfile":{ + "name":"DeleteProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProfileRequest"}, + "output":{"shape":"DeleteProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a room profile by the profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteRoom":{ + "name":"DeleteRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoomRequest"}, + "output":{"shape":"DeleteRoomResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a room by the room ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteRoomSkillParameter":{ + "name":"DeleteRoomSkillParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoomSkillParameterRequest"}, + "output":{"shape":"DeleteRoomSkillParameterResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes room skill parameter details by room, skill, and parameter key ID.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteSkillAuthorization":{ + "name":"DeleteSkillAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSkillAuthorizationRequest"}, + "output":{"shape":"DeleteSkillAuthorizationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Unlinks a third-party account from a skill.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteSkillGroup":{ + "name":"DeleteSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSkillGroupRequest"}, + "output":{"shape":"DeleteSkillGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a skill group by skill group ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a specified user by user ARN and enrollment ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DisassociateContactFromAddressBook":{ + "name":"DisassociateContactFromAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateContactFromAddressBookRequest"}, + "output":{"shape":"DisassociateContactFromAddressBookResponse"}, + "documentation":"

Disassociates a contact from a given address book.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DisassociateDeviceFromRoom":{ + "name":"DisassociateDeviceFromRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDeviceFromRoomRequest"}, + "output":{"shape":"DisassociateDeviceFromRoomResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DisassociateSkillFromSkillGroup":{ + "name":"DisassociateSkillFromSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillFromSkillGroupRequest"}, + "output":{"shape":"DisassociateSkillFromSkillGroupResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Disassociates a skill from a skill group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DisassociateSkillFromUsers":{ + "name":"DisassociateSkillFromUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillFromUsersRequest"}, + "output":{"shape":"DisassociateSkillFromUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "DisassociateSkillGroupFromRoom":{ + "name":"DisassociateSkillGroupFromRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillGroupFromRoomRequest"}, + "output":{"shape":"DisassociateSkillGroupFromRoomResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ForgetSmartHomeAppliances":{ + "name":"ForgetSmartHomeAppliances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ForgetSmartHomeAppliancesRequest"}, + "output":{"shape":"ForgetSmartHomeAppliancesResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Forgets smart home appliances associated to a room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetAddressBook":{ + "name":"GetAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAddressBookRequest"}, + "output":{"shape":"GetAddressBookResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets address the book details by the address book ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetConferencePreference":{ + "name":"GetConferencePreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConferencePreferenceRequest"}, + "output":{"shape":"GetConferencePreferenceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the existing conference preferences.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetConferenceProvider":{ + "name":"GetConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConferenceProviderRequest"}, + "output":{"shape":"GetConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets details about a specific conference provider.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetContact":{ + "name":"GetContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContactRequest"}, + "output":{"shape":"GetContactResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets the contact details by the contact ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetDevice":{ + "name":"GetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeviceRequest"}, + "output":{"shape":"GetDeviceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets the details of a device by device ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetGateway":{ + "name":"GetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGatewayRequest"}, + "output":{"shape":"GetGatewayResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the details of a gateway.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetGatewayGroup":{ + "name":"GetGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGatewayGroupRequest"}, + "output":{"shape":"GetGatewayGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the details of a gateway group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetInvitationConfiguration":{ + "name":"GetInvitationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInvitationConfigurationRequest"}, + "output":{"shape":"GetInvitationConfigurationResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the configured values for the user enrollment invitation email template.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetNetworkProfile":{ + "name":"GetNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNetworkProfileRequest"}, + "output":{"shape":"GetNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidSecretsManagerResourceException"} + ], + "documentation":"

Gets the network profile details by the network profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetProfile":{ + "name":"GetProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProfileRequest"}, + "output":{"shape":"GetProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets the details of a room profile by profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetRoom":{ + "name":"GetRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRoomRequest"}, + "output":{"shape":"GetRoomResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets room details by room ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetRoomSkillParameter":{ + "name":"GetRoomSkillParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRoomSkillParameterRequest"}, + "output":{"shape":"GetRoomSkillParameterResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets room skill parameter details by room, skill, and parameter key ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "GetSkillGroup":{ + "name":"GetSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSkillGroupRequest"}, + "output":{"shape":"GetSkillGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets skill group details by skill group ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListBusinessReportSchedules":{ + "name":"ListBusinessReportSchedules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBusinessReportSchedulesRequest"}, + "output":{"shape":"ListBusinessReportSchedulesResponse"}, + "documentation":"

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListConferenceProviders":{ + "name":"ListConferenceProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListConferenceProvidersRequest"}, + "output":{"shape":"ListConferenceProvidersResponse"}, + "documentation":"

Lists conference providers under a specific AWS account.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListDeviceEvents":{ + "name":"ListDeviceEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeviceEventsRequest"}, + "output":{"shape":"ListDeviceEventsResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Lists the device event history, including device connection status, for up to 30 days.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListGatewayGroups":{ + "name":"ListGatewayGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewayGroupsRequest"}, + "output":{"shape":"ListGatewayGroupsResponse"}, + "documentation":"

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListGateways":{ + "name":"ListGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewaysRequest"}, + "output":{"shape":"ListGatewaysResponse"}, + "documentation":"

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListSkills":{ + "name":"ListSkills", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsRequest"}, + "output":{"shape":"ListSkillsResponse"}, + "documentation":"

Lists all enabled skills in a specific skill group.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListSkillsStoreCategories":{ + "name":"ListSkillsStoreCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsStoreCategoriesRequest"}, + "output":{"shape":"ListSkillsStoreCategoriesResponse"}, + "documentation":"

Lists all categories in the Alexa skill store.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListSkillsStoreSkillsByCategory":{ + "name":"ListSkillsStoreSkillsByCategory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsStoreSkillsByCategoryRequest"}, + "output":{"shape":"ListSkillsStoreSkillsByCategoryResponse"}, + "documentation":"

Lists all skills in the Alexa skill store by category.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListSmartHomeAppliances":{ + "name":"ListSmartHomeAppliances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSmartHomeAppliancesRequest"}, + "output":{"shape":"ListSmartHomeAppliancesResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Lists all of the smart home appliances associated with a room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Lists all tags for the specified resource.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "PutConferencePreference":{ + "name":"PutConferencePreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConferencePreferenceRequest"}, + "output":{"shape":"PutConferencePreferenceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Sets the conference preferences on a specific conference provider at the account level.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "PutInvitationConfiguration":{ + "name":"PutInvitationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutInvitationConfigurationRequest"}, + "output":{"shape":"PutInvitationConfigurationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Configures the email template for the user enrollment invitation with the specified attributes.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "PutRoomSkillParameter":{ + "name":"PutRoomSkillParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRoomSkillParameterRequest"}, + "output":{"shape":"PutRoomSkillParameterResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "PutSkillAuthorization":{ + "name":"PutSkillAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSkillAuthorizationRequest"}, + "output":{"shape":"PutSkillAuthorizationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "RegisterAVSDevice":{ + "name":"RegisterAVSDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterAVSDeviceRequest"}, + "output":{"shape":"RegisterAVSDeviceResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidDeviceException"} + ], + "documentation":"

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "RejectSkill":{ + "name":"RejectSkill", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectSkillRequest"}, + "output":{"shape":"RejectSkillResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "ResolveRoom":{ + "name":"ResolveRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveRoomRequest"}, + "output":{"shape":"ResolveRoomResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "RevokeInvitation":{ + "name":"RevokeInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeInvitationRequest"}, + "output":{"shape":"RevokeInvitationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Revokes an invitation and invalidates the enrollment URL.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchAddressBooks":{ + "name":"SearchAddressBooks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchAddressBooksRequest"}, + "output":{"shape":"SearchAddressBooksResponse"}, + "documentation":"

Searches address books and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchContacts":{ + "name":"SearchContacts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchContactsRequest"}, + "output":{"shape":"SearchContactsResponse"}, + "documentation":"

Searches contacts and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchDevices":{ + "name":"SearchDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchDevicesRequest"}, + "output":{"shape":"SearchDevicesResponse"}, + "documentation":"

Searches devices and lists the ones that meet a set of filter criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchNetworkProfiles":{ + "name":"SearchNetworkProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchNetworkProfilesRequest"}, + "output":{"shape":"SearchNetworkProfilesResponse"}, + "documentation":"

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchProfiles":{ + "name":"SearchProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchProfilesRequest"}, + "output":{"shape":"SearchProfilesResponse"}, + "documentation":"

Searches room profiles and lists the ones that meet a set of filter criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchRooms":{ + "name":"SearchRooms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchRoomsRequest"}, + "output":{"shape":"SearchRoomsResponse"}, + "documentation":"

Searches rooms and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchSkillGroups":{ + "name":"SearchSkillGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchSkillGroupsRequest"}, + "output":{"shape":"SearchSkillGroupsResponse"}, + "documentation":"

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SearchUsers":{ + "name":"SearchUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchUsersRequest"}, + "output":{"shape":"SearchUsersResponse"}, + "documentation":"

Searches users and lists the ones that meet a set of filter and sort criteria.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "SendAnnouncement":{ + "name":"SendAnnouncement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendAnnouncementRequest"}, + "output":{"shape":"SendAnnouncementResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

" + }, + "SendInvitation":{ + "name":"SendInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendInvitationRequest"}, + "output":{"shape":"SendInvitationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidUserStatusException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "StartDeviceSync":{ + "name":"StartDeviceSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDeviceSyncRequest"}, + "output":{"shape":"StartDeviceSyncResponse"}, + "errors":[ + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

  • Bluetooth - This unpairs all bluetooth devices paired with your echo device.

  • Volume - This resets the echo device's volume to the default value.

  • Notifications - This clears all notifications from your echo device.

  • Lists - This clears all to-do items from your echo device.

  • Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "StartSmartHomeApplianceDiscovery":{ + "name":"StartSmartHomeApplianceDiscovery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSmartHomeApplianceDiscoveryRequest"}, + "output":{"shape":"StartSmartHomeApplianceDiscoveryResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Initiates the discovery of any smart home appliances associated with the room.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Adds metadata tags to a specified resource.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Removes metadata tags from a specified resource.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateAddressBook":{ + "name":"UpdateAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAddressBookRequest"}, + "output":{"shape":"UpdateAddressBookResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates address book details by the address book ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateBusinessReportSchedule":{ + "name":"UpdateBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBusinessReportScheduleRequest"}, + "output":{"shape":"UpdateBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the configuration of the report delivery schedule with the specified schedule ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateConferenceProvider":{ + "name":"UpdateConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConferenceProviderRequest"}, + "output":{"shape":"UpdateConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Updates an existing conference provider's settings.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateContact":{ + "name":"UpdateContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateContactRequest"}, + "output":{"shape":"UpdateContactResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the contact details by the contact ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateDevice":{ + "name":"UpdateDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDeviceRequest"}, + "output":{"shape":"UpdateDeviceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Updates the device name by device ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateGateway":{ + "name":"UpdateGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayRequest"}, + "output":{"shape":"UpdateGatewayResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"} + ], + "documentation":"

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateGatewayGroup":{ + "name":"UpdateGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayGroupRequest"}, + "output":{"shape":"UpdateGatewayGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"} + ], + "documentation":"

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateNetworkProfile":{ + "name":"UpdateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNetworkProfileRequest"}, + "output":{"shape":"UpdateNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"}, + {"shape":"InvalidSecretsManagerResourceException"} + ], + "documentation":"

Updates a network profile by the network profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateProfile":{ + "name":"UpdateProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProfileRequest"}, + "output":{"shape":"UpdateProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates an existing room profile by room profile ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateRoom":{ + "name":"UpdateRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRoomRequest"}, + "output":{"shape":"UpdateRoomResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"} + ], + "documentation":"

Updates room details by room ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + }, + "UpdateSkillGroup":{ + "name":"UpdateSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSkillGroupRequest"}, + "output":{"shape":"UpdateSkillGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates skill group details by skill group ARN.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" + } + }, + "shapes":{ + "Address":{ + "type":"string", + "max":500, + "min":1 + }, + "AddressBook":{ + "type":"structure", + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book.

" + }, + "Name":{ + "shape":"AddressBookName", + "documentation":"

The name of the address book.

" + }, + "Description":{ + "shape":"AddressBookDescription", + "documentation":"

The description of the address book.

" + } + }, + "documentation":"

An address book with attributes.

" + }, + "AddressBookData":{ + "type":"structure", + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book.

" + }, + "Name":{ + "shape":"AddressBookName", + "documentation":"

The name of the address book.

" + }, + "Description":{ + "shape":"AddressBookDescription", + "documentation":"

The description of the address book.

" + } + }, + "documentation":"

Information related to an address book.

" + }, + "AddressBookDataList":{ + "type":"list", + "member":{"shape":"AddressBookData"} + }, + "AddressBookDescription":{ + "type":"string", + "max":200, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "AddressBookName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource being created already exists.

", + "exception":true + }, + "AmazonId":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,18}" + }, + "ApplianceDescription":{"type":"string"}, + "ApplianceFriendlyName":{"type":"string"}, + "ApplianceManufacturerName":{"type":"string"}, + "ApproveSkillRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "ApproveSkillResponse":{ + "type":"structure", + "members":{ + } + }, + "Arn":{ + "type":"string", + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "AssociateContactWithAddressBookRequest":{ + "type":"structure", + "required":[ + "ContactArn", + "AddressBookArn" + ], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact to associate with an address book.

" + }, + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book with which to associate the contact.

" + } + } + }, + "AssociateContactWithAddressBookResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateDeviceWithNetworkProfileRequest":{ + "type":"structure", + "required":[ + "DeviceArn", + "NetworkProfileArn" + ], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The device ARN.

" + }, + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile to associate with a device.

" + } + } + }, + "AssociateDeviceWithNetworkProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateDeviceWithRoomRequest":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device to associate to a room. Required.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room with which to associate the device. Required.

" + } + } + }, + "AssociateDeviceWithRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateSkillGroupWithRoomRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to associate with a room. Required.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room with which to associate the skill group. Required.

" + } + } + }, + "AssociateSkillGroupWithRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateSkillWithSkillGroupRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to associate the skill to. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "AssociateSkillWithSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateSkillWithUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The private skill ID you want to make available to enrolled users.

" + } + } + }, + "AssociateSkillWithUsersResponse":{ + "type":"structure", + "members":{ + } + }, + "Audio":{ + "type":"structure", + "required":[ + "Locale", + "Location" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the audio message. Currently, en-US is supported.

" + }, + "Location":{ + "shape":"AudioLocation", + "documentation":"

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

" + } + }, + "documentation":"

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:

ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>

" + }, + "AudioList":{ + "type":"list", + "member":{"shape":"Audio"}, + "max":1 + }, + "AudioLocation":{ + "type":"string", + "max":1200, + "min":0, + "pattern":"https://([A-Za-z0-9_.-]+)?(s3-[A-Za-z0-9-]+|s3\\.([A-Za-z0-9-])+|s3|s3.dualstack\\.([A-Za-z0-9-])+)+.amazonaws.com/.*" + }, + "AuthorizationResult":{ + "type":"map", + "key":{"shape":"Key"}, + "value":{"shape":"Value"}, + "sensitive":true + }, + "Boolean":{"type":"boolean"}, + "BulletPoint":{"type":"string"}, + "BulletPoints":{ + "type":"list", + "member":{"shape":"BulletPoint"} + }, + "BusinessReport":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BusinessReportStatus", + "documentation":"

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

" + }, + "FailureCode":{ + "shape":"BusinessReportFailureCode", + "documentation":"

The failure code.

" + }, + "S3Location":{ + "shape":"BusinessReportS3Location", + "documentation":"

The S3 location of the output reports.

" + }, + "DeliveryTime":{ + "shape":"BusinessReportDeliveryTime", + "documentation":"

The time of report delivery.

" + }, + "DownloadUrl":{ + "shape":"BusinessReportDownloadUrl", + "documentation":"

The download link where a user can download the report.

" + } + }, + "documentation":"

Usage report with specified parameters.

" + }, + "BusinessReportContentRange":{ + "type":"structure", + "required":["Interval"], + "members":{ + "Interval":{ + "shape":"BusinessReportInterval", + "documentation":"

The interval of the content range.

" + } + }, + "documentation":"

The content range of the report.

" + }, + "BusinessReportDeliveryTime":{"type":"timestamp"}, + "BusinessReportDownloadUrl":{"type":"string"}, + "BusinessReportFailureCode":{ + "type":"string", + "enum":[ + "ACCESS_DENIED", + "NO_SUCH_BUCKET", + "INTERNAL_FAILURE" + ] + }, + "BusinessReportFormat":{ + "type":"string", + "enum":[ + "CSV", + "CSV_ZIP" + ] + }, + "BusinessReportInterval":{ + "type":"string", + "enum":[ + "ONE_DAY", + "ONE_WEEK", + "THIRTY_DAYS" + ] + }, + "BusinessReportRecurrence":{ + "type":"structure", + "members":{ + "StartDate":{ + "shape":"Date", + "documentation":"

The start date.

" + } + }, + "documentation":"

The recurrence of the reports.

" + }, + "BusinessReportS3Location":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"BusinessReportS3Path", + "documentation":"

The path of the business report.

" + }, + "BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports.

" + } + }, + "documentation":"

The S3 location of the output reports.

" + }, + "BusinessReportS3Path":{"type":"string"}, + "BusinessReportSchedule":{ + "type":"structure", + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + }, + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ContentRange":{ + "shape":"BusinessReportContentRange", + "documentation":"

The content range of the reports.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports.

" + }, + "LastBusinessReport":{ + "shape":"BusinessReport", + "documentation":"

The details of the last business report delivery for a specified time interval.

" + } + }, + "documentation":"

The schedule of the usage report.

" + }, + "BusinessReportScheduleList":{ + "type":"list", + "member":{"shape":"BusinessReportSchedule"} + }, + "BusinessReportScheduleName":{ + "type":"string", + "max":64, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "BusinessReportStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, + "Category":{ + "type":"structure", + "members":{ + "CategoryId":{ + "shape":"CategoryId", + "documentation":"

The ID of the skill store category.

" + }, + "CategoryName":{ + "shape":"CategoryName", + "documentation":"

The name of the skill store category.

" + } + }, + "documentation":"

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

" + }, + "CategoryId":{ + "type":"long", + "min":1 + }, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"} + }, + "CategoryName":{"type":"string"}, + "CertificateTime":{"type":"timestamp"}, + "ClientId":{ + "type":"string", + "pattern":"^\\S+{1,256}$" + }, + "ClientRequestToken":{ + "type":"string", + "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", + "max":150, + "min":10, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "CommsProtocol":{ + "type":"string", + "enum":[ + "SIP", + "SIPS", + "H323" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

There is a concurrent modification of resources.

", + "exception":true + }, + "ConferencePreference":{ + "type":"structure", + "members":{ + "DefaultConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the default conference provider.

" + } + }, + "documentation":"

The default conference provider that is used if no other scheduled meetings are detected.

" + }, + "ConferenceProvider":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created conference provider.

" + }, + "Name":{ + "shape":"ConferenceProviderName", + "documentation":"

The name of the conference provider.

" + }, + "Type":{ + "shape":"ConferenceProviderType", + "documentation":"

The type of conference providers.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + } + }, + "documentation":"

An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

" + }, + "ConferenceProviderName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "ConferenceProviderType":{ + "type":"string", + "enum":[ + "CHIME", + "BLUEJEANS", + "FUZE", + "GOOGLE_HANGOUTS", + "POLYCOM", + "RINGCENTRAL", + "SKYPE_FOR_BUSINESS", + "WEBEX", + "ZOOM", + "CUSTOM" + ] + }, + "ConferenceProvidersList":{ + "type":"list", + "member":{"shape":"ConferenceProvider"} + }, + "ConnectionStatus":{ + "type":"string", + "enum":[ + "ONLINE", + "OFFLINE" + ] + }, + "ConnectionStatusUpdatedTime":{"type":"timestamp"}, + "Contact":{ + "type":"structure", + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact.

" + }, + "DisplayName":{ + "shape":"ContactName", + "documentation":"

The name of the contact to display on the console.

" + }, + "FirstName":{ + "shape":"ContactName", + "documentation":"

The first name of the contact, used to call the contact on the device.

" + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

The last name of the contact, used to call the contact on the device.

" + }, + "PhoneNumber":{ + "shape":"RawPhoneNumber", + "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for the contact.

" + } + }, + "documentation":"

A contact with attributes.

" + }, + "ContactData":{ + "type":"structure", + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact.

" + }, + "DisplayName":{ + "shape":"ContactName", + "documentation":"

The name of the contact to display on the console.

" + }, + "FirstName":{ + "shape":"ContactName", + "documentation":"

The first name of the contact, used to call the contact on the device.

" + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

The last name of the contact, used to call the contact on the device.

" + }, + "PhoneNumber":{ + "shape":"RawPhoneNumber", + "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for the contact.

" + } + }, + "documentation":"

Information related to a contact.

" + }, + "ContactDataList":{ + "type":"list", + "member":{"shape":"ContactData"} + }, + "ContactName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "Content":{ + "type":"structure", + "members":{ + "TextList":{ + "shape":"TextList", + "documentation":"

The list of text messages.

" + }, + "SsmlList":{ + "shape":"SsmlList", + "documentation":"

The list of SSML messages.

" + }, + "AudioList":{ + "shape":"AudioList", + "documentation":"

The list of audio messages.

" + } + }, + "documentation":"

The content definition. This can contain only one text, SSML, or audio list object.

" + }, + "CountryCode":{ + "type":"string", + "pattern":"\\d{1,3}" + }, + "CreateAddressBookRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"AddressBookName", + "documentation":"

The name of the address book.

" + }, + "Description":{ + "shape":"AddressBookDescription", + "documentation":"

The description of the address book.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "CreateAddressBookResponse":{ + "type":"structure", + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created address book.

" + } + } + }, + "CreateBusinessReportScheduleRequest":{ + "type":"structure", + "required":[ + "Format", + "ContentRange" + ], + "members":{ + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ContentRange":{ + "shape":"BusinessReportContentRange", + "documentation":"

The content range of the reports.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The client request token.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the business report schedule.

" + } + } + }, + "CreateBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + } + } + }, + "CreateConferenceProviderRequest":{ + "type":"structure", + "required":[ + "ConferenceProviderName", + "ConferenceProviderType", + "MeetingSetting" + ], + "members":{ + "ConferenceProviderName":{ + "shape":"ConferenceProviderName", + "documentation":"

The name of the conference provider.

" + }, + "ConferenceProviderType":{ + "shape":"ConferenceProviderType", + "documentation":"

Represents a type within a list of predefined types.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token of the client.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "CreateConferenceProviderResponse":{ + "type":"structure", + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly-created conference provider.

" + } + } + }, + "CreateContactRequest":{ + "type":"structure", + "required":["FirstName"], + "members":{ + "DisplayName":{ + "shape":"ContactName", + "documentation":"

The name of the contact to display on the console.

" + }, + "FirstName":{ + "shape":"ContactName", + "documentation":"

The first name of the contact that is used to call the contact on the device.

" + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

The last name of the contact that is used to call the contact on the device.

" + }, + "PhoneNumber":{ + "shape":"RawPhoneNumber", + "documentation":"

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for the contact.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "CreateContactResponse":{ + "type":"structure", + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created address book.

" + } + } + }, + "CreateEndOfMeetingReminder":{ + "type":"structure", + "required":[ + "ReminderAtMinutes", + "ReminderType", + "Enabled" + ], + "members":{ + "ReminderAtMinutes":{ + "shape":"EndOfMeetingReminderMinutesList", + "documentation":"

A range of 3 to 15 minutes that determines when the reminder begins.

" + }, + "ReminderType":{ + "shape":"EndOfMeetingReminderType", + "documentation":"

The type of sound that users hear during the end of meeting reminder.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether an end of meeting reminder is enabled or not.

" + } + }, + "documentation":"

Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "CreateGatewayGroupRequest":{ + "type":"structure", + "required":[ + "Name", + "ClientRequestToken" + ], + "members":{ + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "CreateGatewayGroupResponse":{ + "type":"structure", + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the created gateway group.

" + } + } + }, + "CreateInstantBooking":{ + "type":"structure", + "required":[ + "DurationInMinutes", + "Enabled" + ], + "members":{ + "DurationInMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether instant booking is enabled or not.

" + } + }, + "documentation":"

Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

" + }, + "CreateMeetingRoomConfiguration":{ + "type":"structure", + "members":{ + "RoomUtilizationMetricsEnabled":{ + "shape":"Boolean", + "documentation":"

Whether room utilization metrics are enabled or not.

" + }, + "EndOfMeetingReminder":{"shape":"CreateEndOfMeetingReminder"}, + "InstantBooking":{ + "shape":"CreateInstantBooking", + "documentation":"

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

" + }, + "RequireCheckIn":{ + "shape":"CreateRequireCheckIn", + "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" + }, + "ProactiveJoin":{"shape":"CreateProactiveJoin"} + }, + "documentation":"

Creates meeting room settings of a room profile.

" + }, + "CreateNetworkProfileRequest":{ + "type":"structure", + "required":[ + "NetworkProfileName", + "Ssid", + "SecurityType", + "ClientRequestToken" + ], + "members":{ + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "CreateNetworkProfileResponse":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "CreateProactiveJoin":{ + "type":"structure", + "required":["EnabledByMotion"], + "members":{ + "EnabledByMotion":{"shape":"Boolean"} + } + }, + "CreateProfileRequest":{ + "type":"structure", + "required":[ + "ProfileName", + "Timezone", + "Address", + "DistanceUnit", + "TemperatureUnit", + "WakeWord" + ], + "members":{ + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The name of a room profile.

" + }, + "Timezone":{ + "shape":"Timezone", + "documentation":"

The time zone used by a room profile.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The valid address for the room.

" + }, + "DistanceUnit":{ + "shape":"DistanceUnit", + "documentation":"

The distance unit to be used by devices in the profile.

" + }, + "TemperatureUnit":{ + "shape":"TemperatureUnit", + "documentation":"

The temperature unit to be used by devices in the profile.

" + }, + "WakeWord":{ + "shape":"WakeWord", + "documentation":"

A wake word for Alexa, Echo, Amazon, or a computer.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale of the room profile. (This is currently only available to a limited preview audience.)

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The user-specified token that is used during the creation of a profile.

", + "idempotencyToken":true + }, + "SetupModeDisabled":{ + "shape":"Boolean", + "documentation":"

Whether room profile setup is enabled.

" + }, + "MaxVolumeLimit":{ + "shape":"MaxVolumeLimit", + "documentation":"

The maximum volume limit for a room profile.

" + }, + "PSTNEnabled":{ + "shape":"Boolean", + "documentation":"

Whether PSTN calling is enabled.

" + }, + "DataRetentionOptIn":{ + "shape":"Boolean", + "documentation":"

Whether data retention of the profile is enabled.

" + }, + "MeetingRoomConfiguration":{ + "shape":"CreateMeetingRoomConfiguration", + "documentation":"

The meeting room settings of a room profile.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the profile.

" + } + } + }, + "CreateProfileResponse":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created room profile in the response.

" + } + } + }, + "CreateRequireCheckIn":{ + "type":"structure", + "required":[ + "ReleaseAfterMinutes", + "Enabled" + ], + "members":{ + "ReleaseAfterMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether require check in is enabled or not.

" + } + }, + "documentation":"

Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" + }, + "CreateRoomRequest":{ + "type":"structure", + "required":["RoomName"], + "members":{ + "RoomName":{ + "shape":"RoomName", + "documentation":"

The name for the room.

" + }, + "Description":{ + "shape":"RoomDescription", + "documentation":"

The description for the room.

" + }, + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The profile ARN for the room. This is required.

" + }, + "ProviderCalendarId":{ + "shape":"ProviderCalendarId", + "documentation":"

The calendar ARN for the room.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the room.

" + } + } + }, + "CreateRoomResponse":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created room in the response.

" + } + } + }, + "CreateSkillGroupRequest":{ + "type":"structure", + "required":["SkillGroupName"], + "members":{ + "SkillGroupName":{ + "shape":"SkillGroupName", + "documentation":"

The name for the skill group.

" + }, + "Description":{ + "shape":"SkillGroupDescription", + "documentation":"

The description for the skill group.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the skill group.

" + } + } + }, + "CreateSkillGroupResponse":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created skill group in the response.

" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"user_UserId", + "documentation":"

The ARN for the user.

" + }, + "FirstName":{ + "shape":"user_FirstName", + "documentation":"

The first name for the user.

" + }, + "LastName":{ + "shape":"user_LastName", + "documentation":"

The last name for the user.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email address for the user.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for this request that ensures idempotency.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the user.

" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created user in the response.

" + } + } + }, + "CurrentWiFiPassword":{ + "type":"string", + "max":128, + "min":5, + "pattern":"[\\x00-\\x7F]*", + "sensitive":true + }, + "CustomerS3BucketName":{ + "type":"string", + "pattern":"[a-z0-9-\\.]{3,63}" + }, + "Date":{ + "type":"string", + "pattern":"^\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + }, + "DeleteAddressBookRequest":{ + "type":"structure", + "required":["AddressBookArn"], + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book to delete.

" + } + } + }, + "DeleteAddressBookResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteBusinessReportScheduleRequest":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + } + } + }, + "DeleteBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteConferenceProviderRequest":{ + "type":"structure", + "required":["ConferenceProviderArn"], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the conference provider.

" + } + } + }, + "DeleteConferenceProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteContactRequest":{ + "type":"structure", + "required":["ContactArn"], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact to delete.

" + } + } + }, + "DeleteContactResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDeviceRequest":{ + "type":"structure", + "required":["DeviceArn"], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device for which to request details.

" + } + } + }, + "DeleteDeviceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDeviceUsageDataRequest":{ + "type":"structure", + "required":[ + "DeviceArn", + "DeviceUsageType" + ], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device.

" + }, + "DeviceUsageType":{ + "shape":"DeviceUsageType", + "documentation":"

The type of usage data to delete.

" + } + } + }, + "DeleteDeviceUsageDataResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to delete.

" + } + } + }, + "DeleteGatewayGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "DeleteNetworkProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteProfileRequest":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room profile to delete. Required.

" + } + } + }, + "DeleteProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRoomRequest":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room to delete. Required.

" + } + } + }, + "DeleteRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRoomSkillParameterRequest":{ + "type":"structure", + "required":[ + "SkillId", + "ParameterKey" + ], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room from which to remove the room skill parameter details.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ID of the skill from which to remove the room skill parameter details.

" + }, + "ParameterKey":{ + "shape":"RoomSkillParameterKey", + "documentation":"

The room skill parameter key for which to remove details.

" + } + } + }, + "DeleteRoomSkillParameterResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSkillAuthorizationRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of a skill.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the skill is authorized for.

" + } + } + }, + "DeleteSkillAuthorizationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSkillGroupRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to delete. Required.

" + } + } + }, + "DeleteSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["EnrollmentId"], + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of the user to delete in the organization. Required.

" + }, + "EnrollmentId":{ + "shape":"EnrollmentId", + "documentation":"

The ARN of the user's enrollment in the organization. Required.

" + } + } + }, + "DeleteUserResponse":{ + "type":"structure", + "members":{ + } + }, + "DeveloperInfo":{ + "type":"structure", + "members":{ + "DeveloperName":{ + "shape":"DeveloperName", + "documentation":"

The name of the developer.

" + }, + "PrivacyPolicy":{ + "shape":"PrivacyPolicy", + "documentation":"

The URL of the privacy policy.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email of the developer.

" + }, + "Url":{ + "shape":"Url", + "documentation":"

The website of the developer.

" + } + }, + "documentation":"

The details about the developer that published the skill.

" + }, + "DeveloperName":{"type":"string"}, + "Device":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of a device.

" + }, + "DeviceSerialNumber":{ + "shape":"DeviceSerialNumber", + "documentation":"

The serial number of a device.

" + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of a device.

" + }, + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of a device.

" + }, + "SoftwareVersion":{ + "shape":"SoftwareVersion", + "documentation":"

The software version of a device.

" + }, + "MacAddress":{ + "shape":"MacAddress", + "documentation":"

The MAC address of a device.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room ARN of a device.

" + }, + "DeviceStatus":{ + "shape":"DeviceStatus", + "documentation":"

The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

" + }, + "DeviceStatusInfo":{ + "shape":"DeviceStatusInfo", + "documentation":"

Detailed information about a device's status.

" + }, + "NetworkProfileInfo":{ + "shape":"DeviceNetworkProfileInfo", + "documentation":"

Detailed information about a device's network profile.

" + } + }, + "documentation":"

A device with attributes.

" + }, + "DeviceData":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of a device.

" + }, + "DeviceSerialNumber":{ + "shape":"DeviceSerialNumber", + "documentation":"

The serial number of a device.

" + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of a device.

" + }, + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of a device.

" + }, + "SoftwareVersion":{ + "shape":"SoftwareVersion", + "documentation":"

The software version of a device.

" + }, + "MacAddress":{ + "shape":"MacAddress", + "documentation":"

The MAC address of a device.

" + }, + "DeviceStatus":{ + "shape":"DeviceStatus", + "documentation":"

The status of a device.

" + }, + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room ARN associated with a device.

" + }, + "RoomName":{ + "shape":"DeviceRoomName", + "documentation":"

The name of the room associated with a device.

" + }, + "DeviceStatusInfo":{ + "shape":"DeviceStatusInfo", + "documentation":"

Detailed information about a device's status.

" + }, + "CreatedTime":{ + "shape":"DeviceDataCreatedTime", + "documentation":"

The time (in epoch) when the device data was created.

" + } + }, + "documentation":"

Device attributes.

" + }, + "DeviceDataCreatedTime":{"type":"timestamp"}, + "DeviceDataList":{ + "type":"list", + "member":{"shape":"DeviceData"} + }, + "DeviceEvent":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"DeviceEventType", + "documentation":"

The type of device event.

" + }, + "Value":{ + "shape":"DeviceEventValue", + "documentation":"

The value of the event.

" + }, + "Timestamp":{ + "shape":"DeviceEventTime", + "documentation":"

The time (in epoch) when the event occurred.

" + } + }, + "documentation":"

The list of device events.

" + }, + "DeviceEventList":{ + "type":"list", + "member":{"shape":"DeviceEvent"} + }, + "DeviceEventTime":{"type":"timestamp"}, + "DeviceEventType":{ + "type":"string", + "enum":[ + "CONNECTION_STATUS", + "DEVICE_STATUS" + ] + }, + "DeviceEventValue":{"type":"string"}, + "DeviceLocale":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceName":{ + "type":"string", + "max":100, + "min":2, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "DeviceNetworkProfileInfo":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "CertificateArn":{ + "shape":"Arn", + "documentation":"

The ARN of the certificate associated with a device.

" + }, + "CertificateExpirationTime":{ + "shape":"CertificateTime", + "documentation":"

The time (in epoch) when the certificate expires.

" + } + }, + "documentation":"

Detailed information about a device's network profile.

" + }, + "DeviceNotRegisteredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request failed because this device is no longer registered and therefore no longer managed by this account.

", + "exception":true + }, + "DeviceRoomName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "DeviceSerialNumber":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,200}" + }, + "DeviceSerialNumberForAVS":{ + "type":"string", + "pattern":"^[a-zA-Z0-9]{1,50}$" + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "READY", + "PENDING", + "WAS_OFFLINE", + "DEREGISTERED", + "FAILED" + ] + }, + "DeviceStatusDetail":{ + "type":"structure", + "members":{ + "Feature":{ + "shape":"Feature", + "documentation":"

The list of available features on the device.

" + }, + "Code":{ + "shape":"DeviceStatusDetailCode", + "documentation":"

The device status detail code.

" + } + }, + "documentation":"

Details of a device’s status.

" + }, + "DeviceStatusDetailCode":{ + "type":"string", + "enum":[ + "DEVICE_SOFTWARE_UPDATE_NEEDED", + "DEVICE_WAS_OFFLINE", + "CREDENTIALS_ACCESS_FAILURE", + "TLS_VERSION_MISMATCH", + "ASSOCIATION_REJECTION", + "AUTHENTICATION_FAILURE", + "DHCP_FAILURE", + "INTERNET_UNAVAILABLE", + "DNS_FAILURE", + "UNKNOWN_FAILURE", + "CERTIFICATE_ISSUING_LIMIT_EXCEEDED", + "INVALID_CERTIFICATE_AUTHORITY", + "NETWORK_PROFILE_NOT_FOUND", + "INVALID_PASSWORD_STATE", + "PASSWORD_NOT_FOUND", + "PASSWORD_MANAGER_ACCESS_DENIED", + "CERTIFICATE_AUTHORITY_ACCESS_DENIED" + ] + }, + "DeviceStatusDetails":{ + "type":"list", + "member":{"shape":"DeviceStatusDetail"} + }, + "DeviceStatusInfo":{ + "type":"structure", + "members":{ + "DeviceStatusDetails":{ + "shape":"DeviceStatusDetails", + "documentation":"

One or more device status detail descriptions.

" + }, + "ConnectionStatus":{ + "shape":"ConnectionStatus", + "documentation":"

The latest available information about the connection status of a device.

" + }, + "ConnectionStatusUpdatedTime":{ + "shape":"ConnectionStatusUpdatedTime", + "documentation":"

The time (in epoch) when the device connection status changed.

" + } + }, + "documentation":"

Detailed information about a device's status.

" + }, + "DeviceType":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,200}" + }, + "DeviceUsageType":{ + "type":"string", + "enum":["VOICE"] + }, + "DisassociateContactFromAddressBookRequest":{ + "type":"structure", + "required":[ + "ContactArn", + "AddressBookArn" + ], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact to disassociate from an address book.

" + }, + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address from which to disassociate the contact.

" + } + } + }, + "DisassociateContactFromAddressBookResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateDeviceFromRoomRequest":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device to disassociate from a room. Required.

" + } + } + }, + "DisassociateDeviceFromRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateSkillFromSkillGroupRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The unique identifier of a skill. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of a skill group to associate to a skill.

" + } + } + }, + "DisassociateSkillFromSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateSkillFromUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The private skill ID you want to make unavailable for enrolled users.

" + } + } + }, + "DisassociateSkillFromUsersResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateSkillGroupFromRoomRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to disassociate from a room. Required.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room from which the skill group is to be disassociated. Required.

" + } + } + }, + "DisassociateSkillGroupFromRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "DistanceUnit":{ + "type":"string", + "enum":[ + "METRIC", + "IMPERIAL" + ] + }, + "Email":{ + "type":"string", + "max":128, + "min":1, + "pattern":"\\w[+-.\\w]*@\\w[\\w\\.\\-]+\\.[0-9a-zA-Z]{2,24}" + }, + "EnablementType":{ + "type":"string", + "enum":[ + "ENABLED", + "PENDING" + ] + }, + "EnablementTypeFilter":{ + "type":"string", + "enum":[ + "ENABLED", + "PENDING" + ] + }, + "EndOfMeetingReminder":{ + "type":"structure", + "members":{ + "ReminderAtMinutes":{ + "shape":"EndOfMeetingReminderMinutesList", + "documentation":"

A range of 3 to 15 minutes that determines when the reminder begins.

" + }, + "ReminderType":{ + "shape":"EndOfMeetingReminderType", + "documentation":"

The type of sound that users hear during the end of meeting reminder.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether an end of meeting reminder is enabled or not.

" + } + }, + "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "EndOfMeetingReminderMinutesList":{ + "type":"list", + "member":{"shape":"Minutes"}, + "max":1, + "min":1 + }, + "EndOfMeetingReminderType":{ + "type":"string", + "enum":[ + "ANNOUNCEMENT_TIME_CHECK", + "ANNOUNCEMENT_VARIABLE_TIME_LEFT", + "CHIME", + "KNOCK" + ] + }, + "EndUserLicenseAgreement":{"type":"string"}, + "Endpoint":{ + "type":"string", + "max":256, + "min":1 + }, + "EnrollmentId":{ + "type":"string", + "max":128, + "min":0 + }, + "EnrollmentStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "PENDING", + "REGISTERED", + "DISASSOCIATING", + "DEREGISTERING" + ] + }, + "ErrorMessage":{"type":"string"}, + "Feature":{ + "type":"string", + "enum":[ + "BLUETOOTH", + "VOLUME", + "NOTIFICATIONS", + "LISTS", + "SKILLS", + "NETWORK_PROFILE", + "SETTINGS", + "ALL" + ] + }, + "Features":{ + "type":"list", + "member":{"shape":"Feature"} + }, + "Filter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"FilterKey", + "documentation":"

The key of a filter.

" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

The values of a filter.

" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

" + }, + "FilterKey":{ + "type":"string", + "max":500, + "min":1 + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":25 + }, + "FilterValue":{ + "type":"string", + "max":500, + "min":1 + }, + "FilterValueList":{ + "type":"list", + "member":{"shape":"FilterValue"}, + "max":50 + }, + "ForgetSmartHomeAppliancesRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the appliances are associated with.

" + } + } + }, + "ForgetSmartHomeAppliancesResponse":{ + "type":"structure", + "members":{ + } + }, + "Gateway":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The description of the gateway.

" + }, + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group that the gateway is associated to.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + }, + "documentation":"

The details of the gateway.

" + }, + "GatewayDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewayGroup":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + } + }, + "documentation":"

The details of the gateway group.

" + }, + "GatewayGroupDescription":{ + "type":"string", + "max":200, + "min":0 + }, + "GatewayGroupName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewayGroupSummaries":{ + "type":"list", + "member":{"shape":"GatewayGroupSummary"} + }, + "GatewayGroupSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + } + }, + "documentation":"

The summary of a gateway group.

" + }, + "GatewayName":{ + "type":"string", + "max":253, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewaySummaries":{ + "type":"list", + "member":{"shape":"GatewaySummary"} + }, + "GatewaySummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The description of the gateway.

" + }, + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group that the gateway is associated to.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + }, + "documentation":"

The summary of a gateway.

" + }, + "GatewayVersion":{ + "type":"string", + "max":50, + "min":1 + }, + "GenericKeyword":{"type":"string"}, + "GenericKeywords":{ + "type":"list", + "member":{"shape":"GenericKeyword"} + }, + "GetAddressBookRequest":{ + "type":"structure", + "required":["AddressBookArn"], + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book for which to request details.

" + } + } + }, + "GetAddressBookResponse":{ + "type":"structure", + "members":{ + "AddressBook":{ + "shape":"AddressBook", + "documentation":"

The details of the requested address book.

" + } + } + }, + "GetConferencePreferenceRequest":{ + "type":"structure", + "members":{ + } + }, + "GetConferencePreferenceResponse":{ + "type":"structure", + "members":{ + "Preference":{ + "shape":"ConferencePreference", + "documentation":"

The conference preference.

" + } + } + }, + "GetConferenceProviderRequest":{ + "type":"structure", + "required":["ConferenceProviderArn"], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created conference provider.

" + } + } + }, + "GetConferenceProviderResponse":{ + "type":"structure", + "members":{ + "ConferenceProvider":{ + "shape":"ConferenceProvider", + "documentation":"

The conference provider.

" + } + } + }, + "GetContactRequest":{ + "type":"structure", + "required":["ContactArn"], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact for which to request details.

" + } + } + }, + "GetContactResponse":{ + "type":"structure", + "members":{ + "Contact":{ + "shape":"Contact", + "documentation":"

The details of the requested contact.

" + } + } + }, + "GetDeviceRequest":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device for which to request details. Required.

" + } + } + }, + "GetDeviceResponse":{ + "type":"structure", + "members":{ + "Device":{ + "shape":"Device", + "documentation":"

The details of the device requested. Required.

" + } + } + }, + "GetGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to get.

" + } + } + }, + "GetGatewayGroupResponse":{ + "type":"structure", + "members":{ + "GatewayGroup":{"shape":"GatewayGroup"} + } + }, + "GetGatewayRequest":{ + "type":"structure", + "required":["GatewayArn"], + "members":{ + "GatewayArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway to get.

" + } + } + }, + "GetGatewayResponse":{ + "type":"structure", + "members":{ + "Gateway":{ + "shape":"Gateway", + "documentation":"

The details of the gateway.

" + } + } + }, + "GetInvitationConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetInvitationConfigurationResponse":{ + "type":"structure", + "members":{ + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"

The name of the organization sending the enrollment invite to a user.

" + }, + "ContactEmail":{ + "shape":"Email", + "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" + }, + "PrivateSkillIds":{ + "shape":"ShortSkillIdList", + "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" + } + } + }, + "GetNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "GetNetworkProfileResponse":{ + "type":"structure", + "members":{ + "NetworkProfile":{ + "shape":"NetworkProfile", + "documentation":"

The network profile associated with a device.

" + } + } + }, + "GetProfileRequest":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room profile for which to request details. Required.

" + } + } + }, + "GetProfileResponse":{ + "type":"structure", + "members":{ + "Profile":{ + "shape":"Profile", + "documentation":"

The details of the room profile requested. Required.

" + } + } + }, + "GetRoomRequest":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room for which to request details. Required.

" + } + } + }, + "GetRoomResponse":{ + "type":"structure", + "members":{ + "Room":{ + "shape":"Room", + "documentation":"

The details of the room requested.

" + } + } + }, + "GetRoomSkillParameterRequest":{ + "type":"structure", + "required":[ + "SkillId", + "ParameterKey" + ], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room from which to get the room skill parameter details.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill from which to get the room skill parameter details. Required.

" + }, + "ParameterKey":{ + "shape":"RoomSkillParameterKey", + "documentation":"

The room skill parameter key for which to get details. Required.

" + } + } + }, + "GetRoomSkillParameterResponse":{ + "type":"structure", + "members":{ + "RoomSkillParameter":{ + "shape":"RoomSkillParameter", + "documentation":"

The details of the room skill parameter requested. Required.

" + } + } + }, + "GetSkillGroupRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group for which to get details. Required.

" + } + } + }, + "GetSkillGroupResponse":{ + "type":"structure", + "members":{ + "SkillGroup":{ + "shape":"SkillGroup", + "documentation":"

The details of the skill group requested. Required.

" + } + } + }, + "IPDialIn":{ + "type":"structure", + "required":[ + "Endpoint", + "CommsProtocol" + ], + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The IP address.

" + }, + "CommsProtocol":{ + "shape":"CommsProtocol", + "documentation":"

The protocol, including SIP, SIPS, and H323.

" + } + }, + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "IconUrl":{"type":"string"}, + "InstantBooking":{ + "type":"structure", + "members":{ + "DurationInMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether instant booking is enabled or not.

" + } + }, + "documentation":"

Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

" + }, + "InvalidCertificateAuthorityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The Certificate Authority can't issue or revoke a certificate.

", + "exception":true + }, + "InvalidDeviceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The device is in an invalid state.

", + "exception":true + }, + "InvalidSecretsManagerResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A password in SecretsManager is in an invalid state.

", + "exception":true + }, + "InvalidServiceLinkedRoleStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service linked role is locked for deletion.

", + "exception":true + }, + "InvalidUserStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The attempt to update a user is invalid due to the user's current status.

", + "exception":true + }, + "InvocationPhrase":{"type":"string"}, + "Key":{ + "type":"string", + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You are performing an action that would put you beyond your account's limits.

", + "exception":true + }, + "ListBusinessReportSchedulesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to list the remaining schedules from the previous API call.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of schedules listed in the call.

" + } + } + }, + "ListBusinessReportSchedulesResponse":{ + "type":"structure", + "members":{ + "BusinessReportSchedules":{ + "shape":"BusinessReportScheduleList", + "documentation":"

The schedule of the reports.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to list the remaining schedules from the previous API call.

" + } + } + }, + "ListConferenceProvidersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of conference providers to be returned, per paginated calls.

" + } + } + }, + "ListConferenceProvidersResponse":{ + "type":"structure", + "members":{ + "ConferenceProviders":{ + "shape":"ConferenceProvidersList", + "documentation":"

The conference providers.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListDeviceEventsRequest":{ + "type":"structure", + "required":["DeviceArn"], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of a device.

" + }, + "EventType":{ + "shape":"DeviceEventType", + "documentation":"

The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + } + }, + "ListDeviceEventsResponse":{ + "type":"structure", + "members":{ + "DeviceEvents":{ + "shape":"DeviceEventList", + "documentation":"

The device events requested for the device ARN.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + } + } + }, + "ListGatewayGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of gateway group summaries to return. The default is 50.

" + } + } + }, + "ListGatewayGroupsResponse":{ + "type":"structure", + "members":{ + "GatewayGroups":{ + "shape":"GatewayGroupSummaries", + "documentation":"

The gateway groups in the list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" + } + } + }, + "ListGatewaysRequest":{ + "type":"structure", + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The gateway group ARN for which to list gateways.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of gateway summaries to return. The default is 50.

" + } + } + }, + "ListGatewaysResponse":{ + "type":"structure", + "members":{ + "Gateways":{ + "shape":"GatewaySummaries", + "documentation":"

The gateways in the list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" + } + } + }, + "ListSkillsRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group for which to list enabled skills.

" + }, + "EnablementType":{ + "shape":"EnablementTypeFilter", + "documentation":"

Whether the skill is enabled under the user's account.

" + }, + "SkillType":{ + "shape":"SkillTypeFilter", + "documentation":"

Whether the skill is publicly available or is a private skill.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"SkillListMaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + } + }, + "ListSkillsResponse":{ + "type":"structure", + "members":{ + "SkillSummaries":{ + "shape":"SkillSummaryList", + "documentation":"

The list of enabled skills requested. Required.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + } + } + }, + "ListSkillsStoreCategoriesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of categories returned, per paginated calls.

" + } + } + }, + "ListSkillsStoreCategoriesResponse":{ + "type":"structure", + "members":{ + "CategoryList":{ + "shape":"CategoryList", + "documentation":"

The list of categories.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSkillsStoreSkillsByCategoryRequest":{ + "type":"structure", + "required":["CategoryId"], + "members":{ + "CategoryId":{ + "shape":"CategoryId", + "documentation":"

The category ID for which the skills are being retrieved from the skill store.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"SkillListMaxResults", + "documentation":"

The maximum number of skills returned per paginated calls.

" + } + } + }, + "ListSkillsStoreSkillsByCategoryResponse":{ + "type":"structure", + "members":{ + "SkillsStoreSkills":{ + "shape":"SkillsStoreSkillList", + "documentation":"

The skill store skills.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSmartHomeAppliancesRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the appliances are associated with.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of appliances to be returned, per paginated calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSmartHomeAppliancesResponse":{ + "type":"structure", + "members":{ + "SmartHomeAppliances":{ + "shape":"SmartHomeApplianceList", + "documentation":"

The smart home appliances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListTagsRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the specified resource for which to list tags.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + } + }, + "ListTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The tags requested for the specified resource.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + } + } + }, + "Locale":{ + "type":"string", + "enum":["en-US"] + }, + "MacAddress":{"type":"string"}, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxVolumeLimit":{"type":"integer"}, + "MeetingRoomConfiguration":{ + "type":"structure", + "members":{ + "RoomUtilizationMetricsEnabled":{ + "shape":"Boolean", + "documentation":"

Whether room utilization metrics are enabled or not.

" + }, + "EndOfMeetingReminder":{ + "shape":"EndOfMeetingReminder", + "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "InstantBooking":{ + "shape":"InstantBooking", + "documentation":"

Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.

" + }, + "RequireCheckIn":{ + "shape":"RequireCheckIn", + "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" + }, + "ProactiveJoin":{"shape":"ProactiveJoin"} + }, + "documentation":"

Meeting room settings of a room profile.

" + }, + "MeetingSetting":{ + "type":"structure", + "required":["RequirePin"], + "members":{ + "RequirePin":{ + "shape":"RequirePin", + "documentation":"

The values that indicate whether the pin is always required.

" + } + }, + "documentation":"

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

  • If YES, Alexa will always ask for a meeting pin.

  • If NO, Alexa will never ask for a meeting pin.

  • If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.

" + }, + "Minutes":{"type":"integer"}, + "NameInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The name sent in the request is already in use.

", + "exception":true + }, + "NetworkEapMethod":{ + "type":"string", + "enum":["EAP_TLS"] + }, + "NetworkProfile":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.

" + } + }, + "documentation":"

The network profile associated with a device.

" + }, + "NetworkProfileData":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + } + }, + "documentation":"

The data associated with a network profile.

" + }, + "NetworkProfileDataList":{ + "type":"list", + "member":{"shape":"NetworkProfileData"} + }, + "NetworkProfileDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NetworkProfileName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NetworkSecurityType":{ + "type":"string", + "enum":[ + "OPEN", + "WEP", + "WPA_PSK", + "WPA2_PSK", + "WPA2_ENTERPRISE" + ] + }, + "NetworkSsid":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NewInThisVersionBulletPoints":{ + "type":"list", + "member":{"shape":"BulletPoint"} + }, + "NextToken":{ + "type":"string", + "max":1100, + "min":1 + }, + "NextWiFiPassword":{ + "type":"string", + "max":128, + "min":0, + "pattern":"(^$)|([\\x00-\\x7F]{5,})", + "sensitive":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource is not found.

", + "exception":true + }, + "OneClickIdDelay":{ + "type":"string", + "max":2, + "min":1 + }, + "OneClickPinDelay":{ + "type":"string", + "max":2, + "min":1 + }, + "OrganizationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "OutboundPhoneNumber":{ + "type":"string", + "pattern":"\\d{10}" + }, + "PSTNDialIn":{ + "type":"structure", + "required":[ + "CountryCode", + "PhoneNumber", + "OneClickIdDelay", + "OneClickPinDelay" + ], + "members":{ + "CountryCode":{ + "shape":"CountryCode", + "documentation":"

The zip code.

" + }, + "PhoneNumber":{ + "shape":"OutboundPhoneNumber", + "documentation":"

The phone number to call to join the conference.

" + }, + "OneClickIdDelay":{ + "shape":"OneClickIdDelay", + "documentation":"

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" + }, + "OneClickPinDelay":{ + "shape":"OneClickPinDelay", + "documentation":"

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" + } + }, + "documentation":"

The information for public switched telephone network (PSTN) conferencing.

" + }, + "PhoneNumber":{ + "type":"structure", + "required":[ + "Number", + "Type" + ], + "members":{ + "Number":{ + "shape":"RawPhoneNumber", + "documentation":"

The raw value of the phone number.

" + }, + "Type":{ + "shape":"PhoneNumberType", + "documentation":"

The type of the phone number.

" + } + }, + "documentation":"

The phone number for the contact containing the raw number and phone number type.

" + }, + "PhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"}, + "max":3, + "min":0 + }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "MOBILE", + "WORK", + "HOME" + ], + "sensitive":true + }, + "PrivacyPolicy":{"type":"string"}, + "ProactiveJoin":{ + "type":"structure", + "members":{ + "EnabledByMotion":{"shape":"Boolean"} + } + }, + "ProductDescription":{"type":"string"}, + "ProductId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_]{1,256}$" + }, + "Profile":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of a room profile.

" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The name of a room profile.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Retrieves if the profile is default or not.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The address of a room profile.

" + }, + "Timezone":{ + "shape":"Timezone", + "documentation":"

The time zone of a room profile.

" + }, + "DistanceUnit":{ + "shape":"DistanceUnit", + "documentation":"

The distance unit of a room profile.

" + }, + "TemperatureUnit":{ + "shape":"TemperatureUnit", + "documentation":"

The temperature unit of a room profile.

" + }, + "WakeWord":{ + "shape":"WakeWord", + "documentation":"

The wake word of a room profile.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale of a room profile. (This is currently available only to a limited preview audience.)

" + }, + "SetupModeDisabled":{ + "shape":"Boolean", + "documentation":"

The setup mode of a room profile.

" + }, + "MaxVolumeLimit":{ + "shape":"MaxVolumeLimit", + "documentation":"

The max volume limit of a room profile.

" + }, + "PSTNEnabled":{ + "shape":"Boolean", + "documentation":"

The PSTN setting of a room profile.

" + }, + "DataRetentionOptIn":{ + "shape":"Boolean", + "documentation":"

Whether data retention of the profile is enabled.

" + }, + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book.

" + }, + "MeetingRoomConfiguration":{ + "shape":"MeetingRoomConfiguration", + "documentation":"

Meeting room settings of a room profile.

" + } + }, + "documentation":"

A room profile with attributes.

" + }, + "ProfileData":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of a room profile.

" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The name of a room profile.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Retrieves if the profile data is default or not.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The address of a room profile.

" + }, + "Timezone":{ + "shape":"Timezone", + "documentation":"

The time zone of a room profile.

" + }, + "DistanceUnit":{ + "shape":"DistanceUnit", + "documentation":"

The distance unit of a room profile.

" + }, + "TemperatureUnit":{ + "shape":"TemperatureUnit", + "documentation":"

The temperature unit of a room profile.

" + }, + "WakeWord":{ + "shape":"WakeWord", + "documentation":"

The wake word of a room profile.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale of a room profile. (This is currently available only to a limited preview audience.)

" + } + }, + "documentation":"

The data of a room profile.

" + }, + "ProfileDataList":{ + "type":"list", + "member":{"shape":"ProfileData"} + }, + "ProfileName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "ProviderCalendarId":{ + "type":"string", + "max":100, + "min":0 + }, + "PutConferencePreferenceRequest":{ + "type":"structure", + "required":["ConferencePreference"], + "members":{ + "ConferencePreference":{ + "shape":"ConferencePreference", + "documentation":"

The conference preference of a specific conference provider.

" + } + } + }, + "PutConferencePreferenceResponse":{ + "type":"structure", + "members":{ + } + }, + "PutInvitationConfigurationRequest":{ + "type":"structure", + "required":["OrganizationName"], + "members":{ + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"

The name of the organization sending the enrollment invite to a user.

" + }, + "ContactEmail":{ + "shape":"Email", + "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" + }, + "PrivateSkillIds":{ + "shape":"ShortSkillIdList", + "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" + } + } + }, + "PutInvitationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "PutRoomSkillParameterRequest":{ + "type":"structure", + "required":[ + "SkillId", + "RoomSkillParameter" + ], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room associated with the room skill parameter. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill associated with the room skill parameter. Required.

" + }, + "RoomSkillParameter":{ + "shape":"RoomSkillParameter", + "documentation":"

The updated room skill parameter. Required.

" + } + } + }, + "PutRoomSkillParameterResponse":{ + "type":"structure", + "members":{ + } + }, + "PutSkillAuthorizationRequest":{ + "type":"structure", + "required":[ + "AuthorizationResult", + "SkillId" + ], + "members":{ + "AuthorizationResult":{ + "shape":"AuthorizationResult", + "documentation":"

The authorization result specific to OAUTH code grant output. \"Code” must be populated in the AuthorizationResult map to establish the authorization.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of a skill.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the skill is authorized for.

" + } + } + }, + "PutSkillAuthorizationResponse":{ + "type":"structure", + "members":{ + } + }, + "RawPhoneNumber":{ + "type":"string", + "max":50, + "min":0, + "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$", + "sensitive":true + }, + "RegisterAVSDeviceRequest":{ + "type":"structure", + "required":[ + "ClientId", + "UserCode", + "ProductId", + "AmazonId" + ], + "members":{ + "ClientId":{ + "shape":"ClientId", + "documentation":"

The client ID of the OEM used for code-based linking authorization on an AVS device.

" + }, + "UserCode":{ + "shape":"UserCode", + "documentation":"

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

" + }, + "ProductId":{ + "shape":"ProductId", + "documentation":"

The product ID used to identify your AVS device during authorization.

" + }, + "DeviceSerialNumber":{ + "shape":"DeviceSerialNumberForAVS", + "documentation":"

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

" + }, + "AmazonId":{ + "shape":"AmazonId", + "documentation":"

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags.

" + } + } + }, + "RegisterAVSDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device.

" + } + } + }, + "RejectSkillRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "RejectSkillResponse":{ + "type":"structure", + "members":{ + } + }, + "ReleaseDate":{"type":"string"}, + "RequireCheckIn":{ + "type":"structure", + "members":{ + "ReleaseAfterMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether require check in is enabled or not.

" + } + }, + "documentation":"

Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" + }, + "RequirePin":{ + "type":"string", + "enum":[ + "YES", + "NO", + "OPTIONAL" + ] + }, + "ResolveRoomRequest":{ + "type":"structure", + "required":[ + "UserId", + "SkillId" + ], + "members":{ + "UserId":{ + "shape":"UserId", + "documentation":"

The ARN of the user. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill that was requested. Required.

" + } + } + }, + "ResolveRoomResponse":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room from which the skill request was invoked.

" + }, + "RoomName":{ + "shape":"RoomName", + "documentation":"

The name of the room from which the skill request was invoked.

" + }, + "RoomSkillParameters":{ + "shape":"RoomSkillParameters", + "documentation":"

Response to get the room profile request. Required.

" + } + } + }, + "ResourceAssociatedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Another resource is associated with the resource in the request.

", + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ClientRequestToken":{"shape":"ClientRequestToken"} + }, + "documentation":"

The resource in the request is already in use.

", + "exception":true + }, + "ReviewKey":{"type":"string"}, + "ReviewValue":{"type":"string"}, + "Reviews":{ + "type":"map", + "key":{"shape":"ReviewKey"}, + "value":{"shape":"ReviewValue"} + }, + "RevokeInvitationRequest":{ + "type":"structure", + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of the user for whom to revoke an enrollment invitation. Required.

" + }, + "EnrollmentId":{ + "shape":"EnrollmentId", + "documentation":"

The ARN of the enrollment invitation to revoke. Required.

" + } + } + }, + "RevokeInvitationResponse":{ + "type":"structure", + "members":{ + } + }, + "Room":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of a room.

" + }, + "RoomName":{ + "shape":"RoomName", + "documentation":"

The name of a room.

" + }, + "Description":{ + "shape":"RoomDescription", + "documentation":"

The description of a room.

" + }, + "ProviderCalendarId":{ + "shape":"ProviderCalendarId", + "documentation":"

The provider calendar ARN of a room.

" + }, + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The profile ARN of a room.

" + } + }, + "documentation":"

A room with attributes.

" + }, + "RoomData":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of a room.

" + }, + "RoomName":{ + "shape":"RoomName", + "documentation":"

The name of a room.

" + }, + "Description":{ + "shape":"RoomDescription", + "documentation":"

The description of a room.

" + }, + "ProviderCalendarId":{ + "shape":"ProviderCalendarId", + "documentation":"

The provider calendar ARN of a room.

" + }, + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The profile ARN of a room.

" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The profile name of a room.

" + } + }, + "documentation":"

The data of a room.

" + }, + "RoomDataList":{ + "type":"list", + "member":{"shape":"RoomData"} + }, + "RoomDescription":{ + "type":"string", + "max":200, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "RoomName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "RoomSkillParameter":{ + "type":"structure", + "required":[ + "ParameterKey", + "ParameterValue" + ], + "members":{ + "ParameterKey":{ + "shape":"RoomSkillParameterKey", + "documentation":"

The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

" + }, + "ParameterValue":{ + "shape":"RoomSkillParameterValue", + "documentation":"

The parameter value of a room skill parameter.

" + } + }, + "documentation":"

A skill parameter associated with a room.

" + }, + "RoomSkillParameterKey":{ + "type":"string", + "max":256, + "min":1 + }, + "RoomSkillParameterValue":{ + "type":"string", + "max":512, + "min":1 + }, + "RoomSkillParameters":{ + "type":"list", + "member":{"shape":"RoomSkillParameter"} + }, + "S3KeyPrefix":{ + "type":"string", + "max":100, + "min":0, + "pattern":"[A-Za-z0-9!_\\-\\.\\*'()/]*" + }, + "SampleUtterances":{ + "type":"list", + "member":{"shape":"Utterance"} + }, + "SearchAddressBooksRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + } + }, + "SearchAddressBooksResponse":{ + "type":"structure", + "members":{ + "AddressBooks":{ + "shape":"AddressBookDataList", + "documentation":"

The address books that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of address books returned.

" + } + } + }, + "SearchContactsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + } + }, + "SearchContactsResponse":{ + "type":"structure", + "members":{ + "Contacts":{ + "shape":"ContactDataList", + "documentation":"

The contacts that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of contacts returned.

" + } + } + }, + "SearchDevicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" + } + } + }, + "SearchDevicesResponse":{ + "type":"structure", + "members":{ + "Devices":{ + "shape":"DeviceDataList", + "documentation":"

The devices that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of devices returned.

" + } + } + }, + "SearchNetworkProfilesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

" + } + } + }, + "SearchNetworkProfilesResponse":{ + "type":"structure", + "members":{ + "NetworkProfiles":{ + "shape":"NetworkProfileDataList", + "documentation":"

The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of network profiles returned.

" + } + } + }, + "SearchProfilesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

" + } + } + }, + "SearchProfilesResponse":{ + "type":"structure", + "members":{ + "Profiles":{ + "shape":"ProfileDataList", + "documentation":"

The profiles that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of room profiles returned.

" + } + } + }, + "SearchRoomsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

" + } + } + }, + "SearchRoomsResponse":{ + "type":"structure", + "members":{ + "Rooms":{ + "shape":"RoomDataList", + "documentation":"

The rooms that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of rooms returned.

" + } + } + }, + "SearchSkillGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

" + } + } + }, + "SearchSkillGroupsResponse":{ + "type":"structure", + "members":{ + "SkillGroups":{ + "shape":"SkillGroupDataList", + "documentation":"

The skill groups that meet the filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of skill groups returned.

" + } + } + }, + "SearchUsersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" + } + } + }, + "SearchUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UserDataList", + "documentation":"

The users that meet the specified set of filter criteria, in sort order.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned to indicate that there is more data available.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of users returned.

" + } + } + }, + "SendAnnouncementRequest":{ + "type":"structure", + "required":[ + "RoomFilters", + "Content", + "ClientRequestToken" + ], + "members":{ + "RoomFilters":{ + "shape":"FilterList", + "documentation":"

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

" + }, + "Content":{ + "shape":"Content", + "documentation":"

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

" + }, + "TimeToLiveInSeconds":{ + "shape":"TimeToLiveInSeconds", + "documentation":"

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The unique, user-specified identifier for the request that ensures idempotency.

", + "idempotencyToken":true + } + } + }, + "SendAnnouncementResponse":{ + "type":"structure", + "members":{ + "AnnouncementArn":{ + "shape":"Arn", + "documentation":"

The identifier of the announcement.

" + } + } + }, + "SendInvitationRequest":{ + "type":"structure", + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of the user to whom to send an invitation. Required.

" + } + } + }, + "SendInvitationResponse":{ + "type":"structure", + "members":{ + } + }, + "ShortDescription":{"type":"string"}, + "ShortSkillIdList":{ + "type":"list", + "member":{"shape":"SkillId"}, + "max":3, + "min":0 + }, + "SipAddress":{ + "type":"structure", + "required":[ + "Uri", + "Type" + ], + "members":{ + "Uri":{ + "shape":"SipUri", + "documentation":"

The URI for the SIP address.

" + }, + "Type":{ + "shape":"SipType", + "documentation":"

The type of the SIP address.

" + } + }, + "documentation":"

The SIP address for the contact containing the URI and SIP address type.

" + }, + "SipAddressList":{ + "type":"list", + "member":{"shape":"SipAddress"}, + "max":1, + "min":0 + }, + "SipType":{ + "type":"string", + "enum":["WORK"], + "sensitive":true + }, + "SipUri":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^sip[s]?:([^@:]+)\\@([^@]+)$", + "sensitive":true + }, + "SkillDetails":{ + "type":"structure", + "members":{ + "ProductDescription":{ + "shape":"ProductDescription", + "documentation":"

The description of the product.

" + }, + "InvocationPhrase":{ + "shape":"InvocationPhrase", + "documentation":"

The phrase used to trigger the skill.

" + }, + "ReleaseDate":{ + "shape":"ReleaseDate", + "documentation":"

The date when the skill was released.

" + }, + "EndUserLicenseAgreement":{ + "shape":"EndUserLicenseAgreement", + "documentation":"

The URL of the end user license agreement.

" + }, + "GenericKeywords":{ + "shape":"GenericKeywords", + "documentation":"

The generic keywords associated with the skill that can be used to find a skill.

" + }, + "BulletPoints":{ + "shape":"BulletPoints", + "documentation":"

The details about what the skill supports organized as bullet points.

" + }, + "NewInThisVersionBulletPoints":{ + "shape":"NewInThisVersionBulletPoints", + "documentation":"

The updates added in bullet points.

" + }, + "SkillTypes":{ + "shape":"SkillTypes", + "documentation":"

The types of skills.

" + }, + "Reviews":{ + "shape":"Reviews", + "documentation":"

This member has been deprecated.

The list of reviews for the skill, including Key and Value pair.

" + }, + "DeveloperInfo":{ + "shape":"DeveloperInfo", + "documentation":"

The details about the developer that published the skill.

" + } + }, + "documentation":"

Granular information about the skill.

" + }, + "SkillGroup":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of a skill group.

" + }, + "SkillGroupName":{ + "shape":"SkillGroupName", + "documentation":"

The name of a skill group.

" + }, + "Description":{ + "shape":"SkillGroupDescription", + "documentation":"

The description of a skill group.

" + } + }, + "documentation":"

A skill group with attributes.

" + }, + "SkillGroupData":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The skill group ARN of a skill group.

" + }, + "SkillGroupName":{ + "shape":"SkillGroupName", + "documentation":"

The skill group name of a skill group.

" + }, + "Description":{ + "shape":"SkillGroupDescription", + "documentation":"

The description of a skill group.

" + } + }, + "documentation":"

The attributes of a skill group.

" + }, + "SkillGroupDataList":{ + "type":"list", + "member":{"shape":"SkillGroupData"} + }, + "SkillGroupDescription":{ + "type":"string", + "max":200, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "SkillGroupName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "SkillId":{ + "type":"string", + "pattern":"(^amzn1\\.ask\\.skill\\.[0-9a-f\\-]{1,200})|(^amzn1\\.echo-sdk-ams\\.app\\.[0-9a-f\\-]{1,200})" + }, + "SkillListMaxResults":{ + "type":"integer", + "max":10, + "min":1 + }, + "SkillName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "SkillNotLinkedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The skill must be linked to a third-party account.

", + "exception":true + }, + "SkillStoreType":{"type":"string"}, + "SkillSummary":{ + "type":"structure", + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill summary.

" + }, + "SkillName":{ + "shape":"SkillName", + "documentation":"

The name of the skill.

" + }, + "SupportsLinking":{ + "shape":"boolean", + "documentation":"

Linking support for a skill.

" + }, + "EnablementType":{ + "shape":"EnablementType", + "documentation":"

Whether the skill is enabled under the user's account, or if it requires linking to be used.

" + }, + "SkillType":{ + "shape":"SkillType", + "documentation":"

Whether the skill is publicly available or is a private skill.

" + } + }, + "documentation":"

The summary of skills.

" + }, + "SkillSummaryList":{ + "type":"list", + "member":{"shape":"SkillSummary"} + }, + "SkillType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE" + ], + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "SkillTypeFilter":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE", + "ALL" + ] + }, + "SkillTypes":{ + "type":"list", + "member":{"shape":"SkillStoreType"} + }, + "SkillsStoreSkill":{ + "type":"structure", + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill.

" + }, + "SkillName":{ + "shape":"SkillName", + "documentation":"

The name of the skill.

" + }, + "ShortDescription":{ + "shape":"ShortDescription", + "documentation":"

Short description about the skill.

" + }, + "IconUrl":{ + "shape":"IconUrl", + "documentation":"

The URL where the skill icon resides.

" + }, + "SampleUtterances":{ + "shape":"SampleUtterances", + "documentation":"

Sample utterances that interact with the skill.

" + }, + "SkillDetails":{ + "shape":"SkillDetails", + "documentation":"

Information about the skill.

" + }, + "SupportsLinking":{ + "shape":"boolean", + "documentation":"

Linking support for a skill.

" + } + }, + "documentation":"

The detailed information about an Alexa skill.

" + }, + "SkillsStoreSkillList":{ + "type":"list", + "member":{"shape":"SkillsStoreSkill"} + }, + "SmartHomeAppliance":{ + "type":"structure", + "members":{ + "FriendlyName":{ + "shape":"ApplianceFriendlyName", + "documentation":"

The friendly name of the smart home appliance.

" + }, + "Description":{ + "shape":"ApplianceDescription", + "documentation":"

The description of the smart home appliance.

" + }, + "ManufacturerName":{ + "shape":"ApplianceManufacturerName", + "documentation":"

The name of the manufacturer of the smart home appliance.

" + } + }, + "documentation":"

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

" + }, + "SmartHomeApplianceList":{ + "type":"list", + "member":{"shape":"SmartHomeAppliance"} + }, + "SoftwareVersion":{"type":"string"}, + "Sort":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"SortKey", + "documentation":"

The sort key of a sort object.

" + }, + "Value":{ + "shape":"SortValue", + "documentation":"

The sort value of a sort object.

" + } + }, + "documentation":"

An object representing a sort criteria.

" + }, + "SortKey":{ + "type":"string", + "max":500, + "min":1 + }, + "SortList":{ + "type":"list", + "member":{"shape":"Sort"}, + "max":25 + }, + "SortValue":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "Ssml":{ + "type":"structure", + "required":[ + "Locale", + "Value" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the SSML message. Currently, en-US is supported.

" + }, + "Value":{ + "shape":"SsmlValue", + "documentation":"

The value of the SSML message in the correct SSML format. The audio tag is not supported.

" + } + }, + "documentation":"

The SSML message. For more information, see SSML Reference.

" + }, + "SsmlList":{ + "type":"list", + "member":{"shape":"Ssml"}, + "max":1 + }, + "SsmlValue":{ + "type":"string", + "max":4096, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "StartDeviceSyncRequest":{ + "type":"structure", + "required":["Features"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room with which the device to sync is associated. Required.

" + }, + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device to sync. Required.

" + }, + "Features":{ + "shape":"Features", + "documentation":"

Request structure to start the device sync. Required.

" + } + } + }, + "StartDeviceSyncResponse":{ + "type":"structure", + "members":{ + } + }, + "StartSmartHomeApplianceDiscoveryRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room where smart home appliance discovery was initiated.

" + } + } + }, + "StartSmartHomeApplianceDiscoveryResponse":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of a tag. Tag keys are case-sensitive.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of a tag. Tag values are case sensitive and can be null.

" + } + }, + "documentation":"

A key-value pair that can be associated with a resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "Tags" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource to which to add metadata tags. Required.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be added to the specified resource. Do not provide system tags. Required.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TemperatureUnit":{ + "type":"string", + "enum":[ + "FAHRENHEIT", + "CELSIUS" + ] + }, + "Text":{ + "type":"structure", + "required":[ + "Locale", + "Value" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the text message. Currently, en-US is supported.

" + }, + "Value":{ + "shape":"TextValue", + "documentation":"

The value of the text message.

" + } + }, + "documentation":"

The text message.

" + }, + "TextList":{ + "type":"list", + "member":{"shape":"Text"}, + "max":1 + }, + "TextValue":{ + "type":"string", + "max":4096, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "TimeToLiveInSeconds":{ + "type":"integer", + "max":3600, + "min":1 + }, + "Timezone":{ + "type":"string", + "max":100, + "min":1 + }, + "TotalCount":{"type":"integer"}, + "TrustAnchor":{ + "type":"string", + "pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" + }, + "TrustAnchorList":{ + "type":"list", + "member":{"shape":"TrustAnchor"}, + "max":5, + "min":1 + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The caller has no permissions to operate on the resource involved in the API call.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "TagKeys" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource from which to remove metadata tags. Required.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tags to be removed from the specified resource. Do not provide system tags. Required.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAddressBookRequest":{ + "type":"structure", + "required":["AddressBookArn"], + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room to update.

" + }, + "Name":{ + "shape":"AddressBookName", + "documentation":"

The updated name of the room.

" + }, + "Description":{ + "shape":"AddressBookDescription", + "documentation":"

The updated description of the room.

" + } + } + }, + "UpdateAddressBookResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBusinessReportScheduleRequest":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 location of the output reports.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports.

" + } + } + }, + "UpdateBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateConferenceProviderRequest":{ + "type":"structure", + "required":[ + "ConferenceProviderArn", + "ConferenceProviderType", + "MeetingSetting" + ], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the conference provider.

" + }, + "ConferenceProviderType":{ + "shape":"ConferenceProviderType", + "documentation":"

The type of the conference provider.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + } + } + }, + "UpdateConferenceProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateContactRequest":{ + "type":"structure", + "required":["ContactArn"], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact to update.

" + }, + "DisplayName":{ + "shape":"ContactName", + "documentation":"

The updated display name of the contact.

" + }, + "FirstName":{ + "shape":"ContactName", + "documentation":"

The updated first name of the contact.

" + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

The updated last name of the contact.

" + }, + "PhoneNumber":{ + "shape":"RawPhoneNumber", + "documentation":"

The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for the contact.

" + } + } + }, + "UpdateContactResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDeviceRequest":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device to update. Required.

" + }, + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The updated device name. Required.

" + } + } + }, + "UpdateDeviceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateEndOfMeetingReminder":{ + "type":"structure", + "members":{ + "ReminderAtMinutes":{ + "shape":"EndOfMeetingReminderMinutesList", + "documentation":"

Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "ReminderType":{ + "shape":"EndOfMeetingReminderType", + "documentation":"

The type of sound that users hear during the end of meeting reminder.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether an end of meeting reminder is enabled or not.

" + } + }, + "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "UpdateGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to update.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The updated name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The updated description of the gateway group.

" + } + } + }, + "UpdateGatewayGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateGatewayRequest":{ + "type":"structure", + "required":["GatewayArn"], + "members":{ + "GatewayArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway to update.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The updated name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The updated description of the gateway.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + } + }, + "UpdateGatewayResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateInstantBooking":{ + "type":"structure", + "members":{ + "DurationInMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether instant booking is enabled or not.

" + } + }, + "documentation":"

Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.

" + }, + "UpdateMeetingRoomConfiguration":{ + "type":"structure", + "members":{ + "RoomUtilizationMetricsEnabled":{ + "shape":"Boolean", + "documentation":"

Whether room utilization metrics are enabled or not.

" + }, + "EndOfMeetingReminder":{ + "shape":"UpdateEndOfMeetingReminder", + "documentation":"

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + }, + "InstantBooking":{ + "shape":"UpdateInstantBooking", + "documentation":"

Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.

" + }, + "RequireCheckIn":{ + "shape":"UpdateRequireCheckIn", + "documentation":"

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" + }, + "ProactiveJoin":{"shape":"UpdateProactiveJoin"} + }, + "documentation":"

Updates meeting room settings of a room profile.

" + }, + "UpdateNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

" + } + } + }, + "UpdateNetworkProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateProactiveJoin":{ + "type":"structure", + "required":["EnabledByMotion"], + "members":{ + "EnabledByMotion":{"shape":"Boolean"} + } + }, + "UpdateProfileRequest":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room profile to update. Required.

" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The updated name for the room profile.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Sets the profile as default if selected. If this is missing, no update is done to the default status.

" + }, + "Timezone":{ + "shape":"Timezone", + "documentation":"

The updated timezone for the room profile.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The updated address for the room profile.

" + }, + "DistanceUnit":{ + "shape":"DistanceUnit", + "documentation":"

The updated distance unit for the room profile.

" + }, + "TemperatureUnit":{ + "shape":"TemperatureUnit", + "documentation":"

The updated temperature unit for the room profile.

" + }, + "WakeWord":{ + "shape":"WakeWord", + "documentation":"

The updated wake word for the room profile.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The updated locale for the room profile. (This is currently only available to a limited preview audience.)

" + }, + "SetupModeDisabled":{ + "shape":"Boolean", + "documentation":"

Whether the setup mode of the profile is enabled.

" + }, + "MaxVolumeLimit":{ + "shape":"MaxVolumeLimit", + "documentation":"

The updated maximum volume limit for the room profile.

" + }, + "PSTNEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the PSTN setting of the room profile is enabled.

" + }, + "DataRetentionOptIn":{ + "shape":"Boolean", + "documentation":"

Whether data retention of the profile is enabled.

" + }, + "MeetingRoomConfiguration":{ + "shape":"UpdateMeetingRoomConfiguration", + "documentation":"

The updated meeting room settings of a room profile.

" + } + } + }, + "UpdateProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRequireCheckIn":{ + "type":"structure", + "members":{ + "ReleaseAfterMinutes":{ + "shape":"Minutes", + "documentation":"

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether require check in is enabled or not.

" + } + }, + "documentation":"

Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

" + }, + "UpdateRoomRequest":{ + "type":"structure", + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room to update.

" + }, + "RoomName":{ + "shape":"RoomName", + "documentation":"

The updated name for the room.

" + }, + "Description":{ + "shape":"RoomDescription", + "documentation":"

The updated description for the room.

" + }, + "ProviderCalendarId":{ + "shape":"ProviderCalendarId", + "documentation":"

The updated provider calendar ARN for the room.

" + }, + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The updated profile ARN for the room.

" + } + } + }, + "UpdateRoomResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateSkillGroupRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to update.

" + }, + "SkillGroupName":{ + "shape":"SkillGroupName", + "documentation":"

The updated name for the skill group.

" + }, + "Description":{ + "shape":"SkillGroupDescription", + "documentation":"

The updated description for the skill group.

" + } + } + }, + "UpdateSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "Url":{"type":"string"}, + "UserCode":{ + "type":"string", + "max":128, + "min":1 + }, + "UserData":{ + "type":"structure", + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of a user.

" + }, + "FirstName":{ + "shape":"user_FirstName", + "documentation":"

The first name of a user.

" + }, + "LastName":{ + "shape":"user_LastName", + "documentation":"

The last name of a user.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email of a user.

" + }, + "EnrollmentStatus":{ + "shape":"EnrollmentStatus", + "documentation":"

The enrollment status of a user.

" + }, + "EnrollmentId":{ + "shape":"EnrollmentId", + "documentation":"

The enrollment ARN of a user.

" + } + }, + "documentation":"

Information related to a user.

" + }, + "UserDataList":{ + "type":"list", + "member":{"shape":"UserData"} + }, + "UserId":{ + "type":"string", + "pattern":"amzn1\\.[A-Za-z0-9+-\\/=.]{1,300}" + }, + "Utterance":{"type":"string"}, + "Value":{ + "type":"string", + "min":1 + }, + "WakeWord":{ + "type":"string", + "enum":[ + "ALEXA", + "AMAZON", + "ECHO", + "COMPUTER" + ] + }, + "boolean":{"type":"boolean"}, + "user_FirstName":{ + "type":"string", + "max":30, + "min":0, + "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*" + }, + "user_LastName":{ + "type":"string", + "max":30, + "min":0, + "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*" + }, + "user_UserId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9@_+.-]*" + } + }, + "documentation":"

Alexa for Business has been retired and is no longer supported.

", + "deprecated":true, + "deprecatedMessage":"Alexa For Business is no longer supported" +} diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 3990171a5c..243af2b794 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -112,6 +112,11 @@ } }, "services" : { + "a4b" : { + "endpoints" : { + "us-east-1" : { } + } + }, "access-analyzer" : { "endpoints" : { "af-south-1" : { }, diff --git a/botocore/utils.py b/botocore/utils.py index cba9a57c02..e2c5c17a00 100644 --- a/botocore/utils.py +++ b/botocore/utils.py @@ -109,6 +109,8 @@ # id, we have to preserve compatibility. This maps the instances where either # is different than the transformed service id. EVENT_ALIASES = { + "a4b": "alexa-for-business", + "alexaforbusiness": "alexa-for-business", "api.mediatailor": "mediatailor", "api.pricing": "pricing", "api.sagemaker": "sagemaker", @@ -3568,6 +3570,7 @@ def is_s3express_bucket(bucket): # values are the transformed service IDs (lower case and hyphenated). CLIENT_NAME_TO_HYPHENIZED_SERVICE_ID_OVERRIDES = { # Actual service name we use -> Allowed computed service name. + 'alexaforbusiness': 'alexa-for-business', 'apigateway': 'api-gateway', 'application-autoscaling': 'application-auto-scaling', 'appmesh': 'app-mesh', diff --git a/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json b/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json new file mode 100644 index 0000000000..de7a21af1d --- /dev/null +++ b/tests/functional/endpoint-rules/alexaforbusiness/endpoint-tests-1.json @@ -0,0 +1,314 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://a4b.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/models/endpoints.json b/tests/functional/models/endpoints.json index 681dedc857..4b9b94a411 100644 --- a/tests/functional/models/endpoints.json +++ b/tests/functional/models/endpoints.json @@ -57,6 +57,11 @@ } }, "services" : { + "a4b" : { + "endpoints" : { + "us-east-1" : { } + } + }, "acm" : { "endpoints" : { "ap-northeast-1" : { }, diff --git a/tests/functional/test_event_alias.py b/tests/functional/test_event_alias.py index 6ddcf513f8..9d0ec1730a 100644 --- a/tests/functional/test_event_alias.py +++ b/tests/functional/test_event_alias.py @@ -8,6 +8,10 @@ SERVICES = { "acm": {"endpoint_prefix": "acm", "service_id": "acm"}, "acm-pca": {"endpoint_prefix": "acm-pca", "service_id": "acm-pca"}, + "alexaforbusiness": { + "endpoint_prefix": "a4b", + "service_id": "alexa-for-business", + }, "apigateway": { "endpoint_prefix": "apigateway", "service_id": "api-gateway", diff --git a/tests/functional/test_paginator_config.py b/tests/functional/test_paginator_config.py index b6a9885904..418a029da4 100644 --- a/tests/functional/test_paginator_config.py +++ b/tests/functional/test_paginator_config.py @@ -32,6 +32,11 @@ # to reference all the extra output keys. Nothing should ever be added to this # list, it represents all the current released paginators that fail this test. KNOWN_EXTRA_OUTPUT_KEYS = [ + 'alexaforbusiness.SearchUsers.TotalCount', + 'alexaforbusiness.SearchProfiles.TotalCount', + 'alexaforbusiness.SearchSkillGroups.TotalCount', + 'alexaforbusiness.SearchDevices.TotalCount', + 'alexaforbusiness.SearchRooms.TotalCount', 'apigateway.GetApiKeys.warnings', 'apigateway.GetUsage.usagePlanId', 'apigateway.GetUsage.startDate', From 5746767784346c253de9d1224d65f5acae42374c Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Fri, 24 May 2024 19:59:45 +0000 Subject: [PATCH 5/7] Update to latest models --- .../api-change-dynamodb-88310.json | 5 ++ .../api-change-iotfleetwise-13340.json | 5 ++ .../api-change-managedblockchain-32834.json | 5 ++ .../data/dynamodb/2012-08-10/service-2.json | 47 ++++++++++--------- .../iotfleetwise/2021-06-17/service-2.json | 22 ++++++++- .../2018-09-24/service-2.json | 9 ++-- 6 files changed, 65 insertions(+), 28 deletions(-) create mode 100644 .changes/next-release/api-change-dynamodb-88310.json create mode 100644 .changes/next-release/api-change-iotfleetwise-13340.json create mode 100644 .changes/next-release/api-change-managedblockchain-32834.json diff --git a/.changes/next-release/api-change-dynamodb-88310.json b/.changes/next-release/api-change-dynamodb-88310.json new file mode 100644 index 0000000000..881be3162f --- /dev/null +++ b/.changes/next-release/api-change-dynamodb-88310.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``dynamodb``", + "description": "Documentation only updates for DynamoDB." +} diff --git a/.changes/next-release/api-change-iotfleetwise-13340.json b/.changes/next-release/api-change-iotfleetwise-13340.json new file mode 100644 index 0000000000..65cbbfe27c --- /dev/null +++ b/.changes/next-release/api-change-iotfleetwise-13340.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``iotfleetwise``", + "description": "AWS IoT FleetWise now supports listing vehicles with attributes filter, ListVehicles API is updated to support additional attributes filter." +} diff --git a/.changes/next-release/api-change-managedblockchain-32834.json b/.changes/next-release/api-change-managedblockchain-32834.json new file mode 100644 index 0000000000..927767b276 --- /dev/null +++ b/.changes/next-release/api-change-managedblockchain-32834.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``managedblockchain``", + "description": "This is a minor documentation update to address the impact of the shut down of the Goerli and Polygon networks." +} diff --git a/botocore/data/dynamodb/2012-08-10/service-2.json b/botocore/data/dynamodb/2012-08-10/service-2.json index a8f3c338c9..9d0bdadbb6 100644 --- a/botocore/data/dynamodb/2012-08-10/service-2.json +++ b/botocore/data/dynamodb/2012-08-10/service-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"dynamodb", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"DynamoDB", "serviceFullName":"Amazon DynamoDB", "serviceId":"DynamoDB", @@ -60,7 +61,7 @@ {"shape":"RequestLimitExceeded"}, {"shape":"InternalServerError"} ], - "documentation":"

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

", + "documentation":"

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

  • Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.

", "endpointdiscovery":{ } }, @@ -98,7 +99,7 @@ {"shape":"GlobalTableAlreadyExistsException"}, {"shape":"TableNotFoundException"} ], - "documentation":"

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

  • The local secondary indexes must have the same name.

  • The local secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

", + "documentation":"

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

  • The local secondary indexes must have the same name.

  • The local secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

", "endpointdiscovery":{ } }, @@ -191,7 +192,7 @@ {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], - "documentation":"

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

This operation only applies to Version 2019.11.21 (Current) of global tables.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

", + "documentation":"

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

", "endpointdiscovery":{ } }, @@ -279,7 +280,7 @@ {"shape":"InternalServerError"}, {"shape":"GlobalTableNotFoundException"} ], - "documentation":"

Returns information about the specified global table.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", + "documentation":"

Returns information about the specified global table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", "endpointdiscovery":{ } }, @@ -295,7 +296,7 @@ {"shape":"GlobalTableNotFoundException"}, {"shape":"InternalServerError"} ], - "documentation":"

Describes Region-specific settings for a global table.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", + "documentation":"

Describes Region-specific settings for a global table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", "endpointdiscovery":{ } }, @@ -355,7 +356,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], - "documentation":"

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

This operation only applies to Version 2019.11.21 (Current) of global tables.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

", + "documentation":"

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

", "endpointdiscovery":{ } }, @@ -371,7 +372,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], - "documentation":"

Describes auto scaling settings across replicas of the global table at once.

This operation only applies to Version 2019.11.21 (Current) of global tables.

" + "documentation":"

Describes auto scaling settings across replicas of the global table at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

" }, "DescribeTimeToLive":{ "name":"DescribeTimeToLive", @@ -586,7 +587,7 @@ "errors":[ {"shape":"InternalServerError"} ], - "documentation":"

Lists all global tables that have a replica in the specified Region.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", + "documentation":"

Lists all global tables that have a replica in the specified Region.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", "endpointdiscovery":{ } }, @@ -871,7 +872,7 @@ {"shape":"ReplicaNotFoundException"}, {"shape":"TableNotFoundException"} ], - "documentation":"

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

", + "documentation":"

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

", "endpointdiscovery":{ } }, @@ -891,7 +892,7 @@ {"shape":"ResourceInUseException"}, {"shape":"InternalServerError"} ], - "documentation":"

Updates settings for a global table.

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", + "documentation":"

Updates settings for a global table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version), as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

", "endpointdiscovery":{ } }, @@ -948,7 +949,7 @@ {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], - "documentation":"

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

This operation only applies to Version 2019.11.21 (Current) of global tables.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

", + "documentation":"

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

", "endpointdiscovery":{ } }, @@ -966,7 +967,7 @@ {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], - "documentation":"

Updates auto scaling settings on your global tables at once.

This operation only applies to Version 2019.11.21 (Current) of global tables.

" + "documentation":"

Updates auto scaling settings on your global tables at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

" }, "UpdateTimeToLive":{ "name":"UpdateTimeToLive", @@ -1838,7 +1839,7 @@ "documentation":"

The amount of throughput consumed on each global index affected by the operation.

" } }, - "documentation":"

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

" }, "ConsumedCapacityMultiple":{ "type":"list", @@ -2077,7 +2078,7 @@ }, "BillingMode":{ "shape":"BillingMode", - "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

" + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", @@ -2281,7 +2282,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", @@ -3157,7 +3158,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a GetItem operation.

" @@ -4659,7 +4660,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", @@ -4806,7 +4807,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a Query operation.

" @@ -5605,7 +5606,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a Scan operation.

" @@ -6388,7 +6389,7 @@ }, "GlobalTableBillingMode":{ "shape":"BillingMode", - "documentation":"

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

" + "documentation":"

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

" }, "GlobalTableProvisionedWriteCapacityUnits":{ "shape":"PositiveLongObject", @@ -6489,7 +6490,7 @@ }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", - "documentation":"

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + "documentation":"

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", @@ -6595,7 +6596,7 @@ }, "BillingMode":{ "shape":"BillingMode", - "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

" + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", @@ -6615,7 +6616,7 @@ }, "ReplicaUpdates":{ "shape":"ReplicationGroupUpdateList", - "documentation":"

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 (Current) of global tables.

" + "documentation":"

A list of replica update actions (create, delete, or update) for the table.

For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

" }, "TableClass":{ "shape":"TableClass", diff --git a/botocore/data/iotfleetwise/2021-06-17/service-2.json b/botocore/data/iotfleetwise/2021-06-17/service-2.json index 26960e3e92..655b9f2727 100644 --- a/botocore/data/iotfleetwise/2021-06-17/service-2.json +++ b/botocore/data/iotfleetwise/2021-06-17/service-2.json @@ -1419,7 +1419,7 @@ }, "signalCatalogArn":{ "shape":"arn", - "documentation":"

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

" + "documentation":"

The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

" }, "targetArn":{ "shape":"arn", @@ -3251,6 +3251,14 @@ "shape":"arn", "documentation":"

The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

" }, + "attributeNames":{ + "shape":"attributeNamesList", + "documentation":"

The fully qualified names of the attributes. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

" + }, + "attributeValues":{ + "shape":"attributeValuesList", + "documentation":"

Static information about a vehicle attribute value in string format. For example:

\"1.3 L R2\"

" + }, "nextToken":{ "shape":"nextToken", "documentation":"

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" @@ -4884,7 +4892,19 @@ "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, + "attributeNamesList":{ + "type":"list", + "member":{"shape":"attributeName"}, + "max":5, + "min":1 + }, "attributeValue":{"type":"string"}, + "attributeValuesList":{ + "type":"list", + "member":{"shape":"attributeValue"}, + "max":5, + "min":1 + }, "attributesMap":{ "type":"map", "key":{"shape":"attributeName"}, diff --git a/botocore/data/managedblockchain/2018-09-24/service-2.json b/botocore/data/managedblockchain/2018-09-24/service-2.json index 8f7a755fd9..e179748dbd 100644 --- a/botocore/data/managedblockchain/2018-09-24/service-2.json +++ b/botocore/data/managedblockchain/2018-09-24/service-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"managedblockchain", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"ManagedBlockchain", "serviceFullName":"Amazon Managed Blockchain", "serviceId":"ManagedBlockchain", @@ -652,7 +653,7 @@ }, "NetworkType":{ "shape":"AccessorNetworkType", - "documentation":"

The blockchain network that the Accessor token is created for.

We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

  • when the CreateAccessor action does not set a networkType.

  • to all existing Accessor tokens that were created before the networkType property was introduced.

" + "documentation":"

The blockchain network that the Accessor token is created for.

  • Use the actual networkType value for the blockchain network that you are creating the Accessor token for.

  • With the shut down of the Ethereum Goerli and Polygon Mumbai Testnet networks the following networkType values are no longer available for selection and use.

    • ETHEREUM_MAINNET_AND_GOERLI

    • ETHEREUM_GOERLI

    • POLYGON_MUMBAI

    However, your existing Accessor tokens with these networkType values will remain unchanged.

" } } }, @@ -790,7 +791,7 @@ }, "NetworkId":{ "shape":"ResourceIdString", - "documentation":"

The unique identifier of the network for the node.

Ethereum public networks have the following NetworkIds:

  • n-ethereum-mainnet

  • n-ethereum-goerli

", + "documentation":"

The unique identifier of the network for the node.

Ethereum public networks have the following NetworkIds:

  • n-ethereum-mainnet

", "location":"uri", "locationName":"networkId" }, @@ -916,7 +917,7 @@ "members":{ "NetworkId":{ "shape":"ResourceIdString", - "documentation":"

The unique identifier of the network that the node is on.

Ethereum public networks have the following NetworkIds:

  • n-ethereum-mainnet

  • n-ethereum-goerli

", + "documentation":"

The unique identifier of the network that the node is on.

Ethereum public networks have the following NetworkIds:

  • n-ethereum-mainnet

", "location":"uri", "locationName":"networkId" }, @@ -1818,7 +1819,7 @@ "members":{ "ChainId":{ "shape":"String", - "documentation":"

The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

  • mainnet = 1

  • goerli = 5

" + "documentation":"

The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

  • mainnet = 1

" } }, "documentation":"

Attributes of Ethereum for a network.

" From ad1ef718df70ea1b82dfec719249f269f64fc8fa Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Fri, 24 May 2024 19:59:46 +0000 Subject: [PATCH 6/7] Update endpoints model --- botocore/data/endpoints.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 998cfec67f..f3318630c6 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -8953,11 +8953,6 @@ "us-west-2" : { } } }, - "honeycode" : { - "endpoints" : { - "us-west-2" : { } - } - }, "iam" : { "endpoints" : { "aws-global" : { @@ -28943,4 +28938,4 @@ "services" : { } } ], "version" : 3 -} \ No newline at end of file +} From 0b92c881ef5a30d1f78513f0f850d3d0edf71b26 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Fri, 24 May 2024 20:00:35 +0000 Subject: [PATCH 7/7] Bumping version to 1.34.113 --- .changes/1.34.113.json | 17 +++++++++++++++++ .../next-release/api-change-dynamodb-88310.json | 5 ----- .../api-change-iotfleetwise-13340.json | 5 ----- .../api-change-managedblockchain-32834.json | 5 ----- CHANGELOG.rst | 8 ++++++++ botocore/__init__.py | 2 +- docs/source/conf.py | 2 +- 7 files changed, 27 insertions(+), 17 deletions(-) create mode 100644 .changes/1.34.113.json delete mode 100644 .changes/next-release/api-change-dynamodb-88310.json delete mode 100644 .changes/next-release/api-change-iotfleetwise-13340.json delete mode 100644 .changes/next-release/api-change-managedblockchain-32834.json diff --git a/.changes/1.34.113.json b/.changes/1.34.113.json new file mode 100644 index 0000000000..cfa389e1f4 --- /dev/null +++ b/.changes/1.34.113.json @@ -0,0 +1,17 @@ +[ + { + "category": "``dynamodb``", + "description": "Documentation only updates for DynamoDB.", + "type": "api-change" + }, + { + "category": "``iotfleetwise``", + "description": "AWS IoT FleetWise now supports listing vehicles with attributes filter, ListVehicles API is updated to support additional attributes filter.", + "type": "api-change" + }, + { + "category": "``managedblockchain``", + "description": "This is a minor documentation update to address the impact of the shut down of the Goerli and Polygon networks.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/api-change-dynamodb-88310.json b/.changes/next-release/api-change-dynamodb-88310.json deleted file mode 100644 index 881be3162f..0000000000 --- a/.changes/next-release/api-change-dynamodb-88310.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``dynamodb``", - "description": "Documentation only updates for DynamoDB." -} diff --git a/.changes/next-release/api-change-iotfleetwise-13340.json b/.changes/next-release/api-change-iotfleetwise-13340.json deleted file mode 100644 index 65cbbfe27c..0000000000 --- a/.changes/next-release/api-change-iotfleetwise-13340.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``iotfleetwise``", - "description": "AWS IoT FleetWise now supports listing vehicles with attributes filter, ListVehicles API is updated to support additional attributes filter." -} diff --git a/.changes/next-release/api-change-managedblockchain-32834.json b/.changes/next-release/api-change-managedblockchain-32834.json deleted file mode 100644 index 927767b276..0000000000 --- a/.changes/next-release/api-change-managedblockchain-32834.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``managedblockchain``", - "description": "This is a minor documentation update to address the impact of the shut down of the Goerli and Polygon networks." -} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 43c45a616e..9bdfd67f16 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,14 @@ CHANGELOG ========= +1.34.113 +======== + +* api-change:``dynamodb``: Documentation only updates for DynamoDB. +* api-change:``iotfleetwise``: AWS IoT FleetWise now supports listing vehicles with attributes filter, ListVehicles API is updated to support additional attributes filter. +* api-change:``managedblockchain``: This is a minor documentation update to address the impact of the shut down of the Goerli and Polygon networks. + + 1.34.112 ======== diff --git a/botocore/__init__.py b/botocore/__init__.py index 9d9e57385e..15fedef539 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.34.112' +__version__ = '1.34.113' class NullHandler(logging.Handler): diff --git a/docs/source/conf.py b/docs/source/conf.py index 0daa18dec2..11f963180e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.1' # The full version, including alpha/beta/rc tags. -release = '1.34.112' +release = '1.34.113' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.