From c50630cd5490a5766a5b36385e331db7fad21784 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 24 Jul 2024 18:17:22 +0000 Subject: [PATCH 1/3] Update to latest models --- .../api-change-cleanrooms-28554.json | 5 + .../api-change-dynamodb-74256.json | 5 + .../api-change-iotsitewise-35719.json | 5 + .../api-change-mediapackagev2-46553.json | 5 + .../api-change-medicalimaging-65420.json | 5 + .../api-change-pinpointsmsvoicev2-43299.json | 5 + .../data/cleanrooms/2022-02-17/service-2.json | 625 ++++++++++++++++-- .../data/dynamodb/2012-08-10/service-2.json | 8 +- .../iotsitewise/2019-12-02/service-2.json | 86 ++- .../mediapackagev2/2022-12-25/service-2.json | 4 +- .../medical-imaging/2023-07-19/service-2.json | 74 ++- .../2022-03-31/service-2.json | 92 +-- 12 files changed, 762 insertions(+), 157 deletions(-) create mode 100644 .changes/next-release/api-change-cleanrooms-28554.json create mode 100644 .changes/next-release/api-change-dynamodb-74256.json create mode 100644 .changes/next-release/api-change-iotsitewise-35719.json create mode 100644 .changes/next-release/api-change-mediapackagev2-46553.json create mode 100644 .changes/next-release/api-change-medicalimaging-65420.json create mode 100644 .changes/next-release/api-change-pinpointsmsvoicev2-43299.json diff --git a/.changes/next-release/api-change-cleanrooms-28554.json b/.changes/next-release/api-change-cleanrooms-28554.json new file mode 100644 index 0000000000..39d28c56f5 --- /dev/null +++ b/.changes/next-release/api-change-cleanrooms-28554.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``cleanrooms``", + "description": "Three enhancements to the AWS Clean Rooms: Disallowed Output Columns, Flexible Result Receivers, SQL as a Seed" +} diff --git a/.changes/next-release/api-change-dynamodb-74256.json b/.changes/next-release/api-change-dynamodb-74256.json new file mode 100644 index 0000000000..3b5e664389 --- /dev/null +++ b/.changes/next-release/api-change-dynamodb-74256.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``dynamodb``", + "description": "DynamoDB doc only update for July" +} diff --git a/.changes/next-release/api-change-iotsitewise-35719.json b/.changes/next-release/api-change-iotsitewise-35719.json new file mode 100644 index 0000000000..b547afc336 --- /dev/null +++ b/.changes/next-release/api-change-iotsitewise-35719.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``iotsitewise``", + "description": "Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device." +} diff --git a/.changes/next-release/api-change-mediapackagev2-46553.json b/.changes/next-release/api-change-mediapackagev2-46553.json new file mode 100644 index 0000000000..f37ab90f74 --- /dev/null +++ b/.changes/next-release/api-change-mediapackagev2-46553.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``mediapackagev2``", + "description": "This release adds support for Irdeto DRM encryption in DASH manifests." +} diff --git a/.changes/next-release/api-change-medicalimaging-65420.json b/.changes/next-release/api-change-medicalimaging-65420.json new file mode 100644 index 0000000000..75a4e87618 --- /dev/null +++ b/.changes/next-release/api-change-medicalimaging-65420.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``medical-imaging``", + "description": "CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter." +} diff --git a/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json b/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json new file mode 100644 index 0000000000..99aec2c817 --- /dev/null +++ b/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``pinpoint-sms-voice-v2``", + "description": "Update for rebrand to AWS End User Messaging SMS and Voice." +} diff --git a/botocore/data/cleanrooms/2022-02-17/service-2.json b/botocore/data/cleanrooms/2022-02-17/service-2.json index d9caacca6a..b427d20b03 100644 --- a/botocore/data/cleanrooms/2022-02-17/service-2.json +++ b/botocore/data/cleanrooms/2022-02-17/service-2.json @@ -186,6 +186,26 @@ ], "documentation":"

Creates a configured table association. A configured table association links a configured table with a collaboration.

" }, + "CreateConfiguredTableAssociationAnalysisRule":{ + "name":"CreateConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"POST", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule", + "responseCode":200 + }, + "input":{"shape":"CreateConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"CreateConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a new analysis rule for an associated configured table.

", + "idempotent":true + }, "CreateIdMappingTable":{ "name":"CreateIdMappingTable", "http":{ @@ -381,6 +401,26 @@ "documentation":"

Deletes a configured table association.

", "idempotent":true }, + "DeleteConfiguredTableAssociationAnalysisRule":{ + "name":"DeleteConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"DELETE", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":204 + }, + "input":{"shape":"DeleteConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"DeleteConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an analysis rule for a configured table association.

", + "idempotent":true + }, "DeleteIdMappingTable":{ "name":"DeleteIdMappingTable", "http":{ @@ -657,6 +697,24 @@ ], "documentation":"

Retrieves a configured table association.

" }, + "GetConfiguredTableAssociationAnalysisRule":{ + "name":"GetConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"GET", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"GetConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"GetConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves the analysis rule for a configured table association.

" + }, "GetIdMappingTable":{ "name":"GetIdMappingTable", "http":{ @@ -1315,6 +1373,25 @@ ], "documentation":"

Updates a configured table association.

" }, + "UpdateConfiguredTableAssociationAnalysisRule":{ + "name":"UpdateConfiguredTableAssociationAnalysisRule", + "http":{ + "method":"PATCH", + "requestUri":"/memberships/{membershipIdentifier}/configuredTableAssociations/{configuredTableAssociationIdentifier}/analysisRule/{analysisRuleType}", + "responseCode":200 + }, + "input":{"shape":"UpdateConfiguredTableAssociationAnalysisRuleInput"}, + "output":{"shape":"UpdateConfiguredTableAssociationAnalysisRuleOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates the analysis rule for a configured table association.

" + }, "UpdateIdMappingTable":{ "name":"UpdateIdMappingTable", "http":{ @@ -1437,6 +1514,20 @@ "min":12, "pattern":"\\d+" }, + "AdditionalAnalyses":{ + "type":"string", + "enum":[ + "ALLOWED", + "REQUIRED", + "NOT_ALLOWED" + ] + }, + "AdditionalAnalysesResourceArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:([\\d]{12}|\\*):membership/[\\*\\d\\w-]+/configuredaudiencemodelassociation/[\\*\\d\\w-]+" + }, "AggregateColumn":{ "type":"structure", "required":[ @@ -1508,12 +1599,22 @@ "type":"string", "enum":["COUNT_DISTINCT"] }, + "AllowedAdditionalAnalyses":{ + "type":"list", + "member":{"shape":"AdditionalAnalysesResourceArn"}, + "max":25, + "min":0 + }, "AllowedColumnList":{ "type":"list", "member":{"shape":"ColumnName"}, "max":225, "min":1 }, + "AllowedResultReceivers":{ + "type":"list", + "member":{"shape":"AccountId"} + }, "AnalysisFormat":{ "type":"string", "enum":["SQL"] @@ -1626,6 +1727,10 @@ "outputConstraints":{ "shape":"AggregationConstraints", "documentation":"

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

" + }, + "additionalAnalyses":{ + "shape":"AdditionalAnalyses", + "documentation":"

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

" } }, "documentation":"

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

" @@ -1657,6 +1762,14 @@ "shape":"AnalysisRuleCustomAllowedAnalysisProvidersList", "documentation":"

The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

" }, + "additionalAnalyses":{ + "shape":"AdditionalAnalyses", + "documentation":"

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

" + }, + "disallowedOutputColumns":{ + "shape":"AnalysisRuleColumnList", + "documentation":"

A list of columns that aren't allowed to be shown in the query output.

" + }, "differentialPrivacy":{ "shape":"DifferentialPrivacyConfiguration", "documentation":"

The differential privacy configuration.

" @@ -1720,6 +1833,10 @@ "listColumns":{ "shape":"AnalysisRuleColumnList", "documentation":"

Columns that can be listed in the output.

" + }, + "additionalAnalyses":{ + "shape":"AdditionalAnalyses", + "documentation":"

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

" } }, "documentation":"

A type of analysis rule that enables row-level analysis.

" @@ -2021,6 +2138,13 @@ "type":"string", "enum":["DIFFERENTIAL_PRIVACY"] }, + "AnalysisType":{ + "type":"string", + "enum":[ + "DIRECT_ANALYSIS", + "ADDITIONAL_ANALYSIS" + ] + }, "BatchGetCollaborationAnalysisTemplateError":{ "type":"structure", "required":[ @@ -2487,7 +2611,7 @@ }, "creatorAccountId":{ "shape":"AccountId", - "documentation":"

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

" + "documentation":"

The identifier used to reference members of the collaboration. Only supports AWS account ID.

" }, "createTime":{ "shape":"Timestamp", @@ -2543,7 +2667,7 @@ }, "creatorAccountId":{ "shape":"AccountId", - "documentation":"

The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID.

" + "documentation":"

The identifier used to reference members of the collaboration. Only supports AWS account ID.

" }, "description":{ "shape":"ResourceDescription", @@ -2976,6 +3100,17 @@ "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*" }, + "ConfigurationDetails":{ + "type":"structure", + "members":{ + "directAnalysisConfigurationDetails":{ + "shape":"DirectAnalysisConfigurationDetails", + "documentation":"

The direct analysis configuration details.

" + } + }, + "documentation":"

The configuration details.

", + "union":true + }, "ConfiguredAudienceModelArn":{ "type":"string", "max":2048, @@ -3324,6 +3459,10 @@ "shape":"TableDescription", "documentation":"

A description of the configured table association.

" }, + "analysisRuleTypes":{ + "shape":"ConfiguredTableAssociationAnalysisRuleTypeList", + "documentation":"

The analysis rule types for the configured table association.

" + }, "createTime":{ "shape":"Timestamp", "documentation":"

The time the configured table association was created.

" @@ -3335,6 +3474,133 @@ }, "documentation":"

A configured table association links a configured table to a collaboration.

" }, + "ConfiguredTableAssociationAnalysisRule":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationId", + "configuredTableAssociationArn", + "policy", + "type", + "createTime", + "updateTime" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

The membership identifier for the configured table association analysis rule.

" + }, + "configuredTableAssociationId":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"

The unique identifier for the configured table association.

" + }, + "configuredTableAssociationArn":{ + "shape":"ConfiguredTableAssociationArn", + "documentation":"

The Amazon Resource Name (ARN) of the configured table association.

" + }, + "policy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"

The policy of the configured table association analysis rule.

" + }, + "type":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"

The type of the configured table association analysis rule.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the configured table association analysis rule.

" + }, + "updateTime":{ + "shape":"Timestamp", + "documentation":"

The update time of the configured table association analysis rule.

" + } + }, + "documentation":"

An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

" + }, + "ConfiguredTableAssociationAnalysisRuleAggregation":{ + "type":"structure", + "members":{ + "allowedResultReceivers":{ + "shape":"AllowedResultReceivers", + "documentation":"

The list of collaboration members who are allowed to receive results of queries run with this configured table.

" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

" + } + }, + "documentation":"

The configured table association analysis rule applied to a configured table with the aggregation analysis rule.

" + }, + "ConfiguredTableAssociationAnalysisRuleCustom":{ + "type":"structure", + "members":{ + "allowedResultReceivers":{ + "shape":"AllowedResultReceivers", + "documentation":"

The list of collaboration members who are allowed to receive results of queries run with this configured table.

" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

" + } + }, + "documentation":"

The configured table association analysis rule applied to a configured table with the custom analysis rule.

" + }, + "ConfiguredTableAssociationAnalysisRuleList":{ + "type":"structure", + "members":{ + "allowedResultReceivers":{ + "shape":"AllowedResultReceivers", + "documentation":"

The list of collaboration members who are allowed to receive results of queries run with this configured table.

" + }, + "allowedAdditionalAnalyses":{ + "shape":"AllowedAdditionalAnalyses", + "documentation":"

The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

" + } + }, + "documentation":"

The configured table association analysis rule applied to a configured table with the list analysis rule.

" + }, + "ConfiguredTableAssociationAnalysisRulePolicy":{ + "type":"structure", + "members":{ + "v1":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicyV1", + "documentation":"

The policy for the configured table association analysis rule.

" + } + }, + "documentation":"

Controls on the query specifications that can be run on an associated configured table.

", + "union":true + }, + "ConfiguredTableAssociationAnalysisRulePolicyV1":{ + "type":"structure", + "members":{ + "list":{ + "shape":"ConfiguredTableAssociationAnalysisRuleList", + "documentation":"

Analysis rule type that enables only list queries on a configured table.

" + }, + "aggregation":{ + "shape":"ConfiguredTableAssociationAnalysisRuleAggregation", + "documentation":"

Analysis rule type that enables only aggregation queries on a configured table.

" + }, + "custom":{ + "shape":"ConfiguredTableAssociationAnalysisRuleCustom", + "documentation":"

Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

" + } + }, + "documentation":"

Controls on the query specifications that can be run on an associated configured table.

", + "union":true + }, + "ConfiguredTableAssociationAnalysisRuleType":{ + "type":"string", + "enum":[ + "AGGREGATION", + "LIST", + "CUSTOM" + ] + }, + "ConfiguredTableAssociationAnalysisRuleTypeList":{ + "type":"list", + "member":{"shape":"ConfiguredTableAssociationAnalysisRuleType"} + }, "ConfiguredTableAssociationArn":{ "type":"string", "max":100, @@ -3593,7 +3859,7 @@ "members":{ "collaboration":{ "shape":"Collaboration", - "documentation":"

The entire created collaboration object.

" + "documentation":"

The collaboration.

" } } }, @@ -3664,7 +3930,7 @@ }, "analysisRulePolicy":{ "shape":"ConfiguredTableAnalysisRulePolicy", - "documentation":"

The entire created configured table analysis rule object.

" + "documentation":"

The analysis rule policy that was created for the configured table.

" } } }, @@ -3674,7 +3940,48 @@ "members":{ "analysisRule":{ "shape":"ConfiguredTableAnalysisRule", - "documentation":"

The entire created analysis rule.

" + "documentation":"

The analysis rule that was created for the configured table.

" + } + } + }, + "CreateConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"

The unique ID for the configured table association. Currently accepts the configured table association ID.

", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"

The type of analysis rule.

" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"

The analysis rule policy that was created for the configured table association.

" + } + } + }, + "CreateConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":"

The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

" } } }, @@ -3721,7 +4028,7 @@ "members":{ "configuredTableAssociation":{ "shape":"ConfiguredTableAssociation", - "documentation":"

The entire configured table association object.

" + "documentation":"

The configured table association.

" } } }, @@ -4068,6 +4375,39 @@ }, "documentation":"

An empty response that indicates a successful delete.

" }, + "DeleteConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"

The identifier for the configured table association that's related to the analysis rule that you want to delete.

", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"

The type of the analysis rule that you want to delete.

", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "DeleteConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "members":{ + } + }, "DeleteConfiguredTableAssociationInput":{ "type":"structure", "required":[ @@ -4487,6 +4827,16 @@ }, "documentation":"

The epsilon and noise parameter values that you want to update in the differential privacy template.

" }, + "DirectAnalysisConfigurationDetails":{ + "type":"structure", + "members":{ + "receiverAccountIds":{ + "shape":"ReceiverAccountIds", + "documentation":"

The account IDs for the member who received the results of a protected query.

" + } + }, + "documentation":"

The direct analysis configuration details.

" + }, "DisplayName":{ "type":"string", "max":100, @@ -4765,6 +5115,44 @@ } } }, + "GetConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"

The identifier for the configured table association that's related to the analysis rule.

", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"

The type of analysis rule that you want to retrieve.

", + "location":"uri", + "locationName":"analysisRuleType" + } + } + }, + "GetConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":"

The analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

" + } + } + }, "GetConfiguredTableAssociationInput":{ "type":"structure", "required":[ @@ -5556,13 +5944,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -5574,7 +5962,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "analysisTemplateSummaries":{ "shape":"AnalysisTemplateSummaryList", @@ -5594,13 +5982,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -5612,7 +6000,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "collaborationAnalysisTemplateSummaries":{ "shape":"CollaborationAnalysisTemplateSummaryList", @@ -5632,13 +6020,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -5654,7 +6042,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -5708,13 +6096,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" } @@ -5726,7 +6114,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "collaborationPrivacyBudgetTemplateSummaries":{ "shape":"CollaborationPrivacyBudgetTemplateSummaryList", @@ -5755,13 +6143,13 @@ }, "maxResults":{ "shape":"MaxResults", - "documentation":"

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

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

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

", "location":"querystring", "locationName":"nextToken" } @@ -5777,7 +6165,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -5786,13 +6174,13 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" }, @@ -5810,7 +6198,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "collaborationList":{ "shape":"CollaborationSummaryList", @@ -5830,13 +6218,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" } @@ -5868,13 +6256,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -5890,7 +6278,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -5899,13 +6287,13 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -5921,7 +6309,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -6013,13 +6401,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -6031,7 +6419,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "memberSummaries":{ "shape":"MemberSummaryList", @@ -6044,13 +6432,13 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" }, @@ -6068,7 +6456,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "membershipSummaries":{ "shape":"MembershipSummaryList", @@ -6088,13 +6476,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" } @@ -6106,7 +6494,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "privacyBudgetTemplateSummaries":{ "shape":"PrivacyBudgetTemplateSummaryList", @@ -6135,13 +6523,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" } @@ -6157,7 +6545,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -6179,13 +6567,13 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.

", "location":"querystring", "locationName":"maxResults" } @@ -6197,7 +6585,7 @@ "members":{ "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" }, "protectedQueries":{ "shape":"ProtectedQuerySummaryList", @@ -6217,19 +6605,19 @@ }, "schemaType":{ "shape":"SchemaType", - "documentation":"

If present, filter schemas by schema type.

", + "documentation":"

If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.

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

The pagination token that's used to fetch the next set of results.

", + "documentation":"

The token value retrieved from a previous call to access the next page of results.

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

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", + "documentation":"

The maximum size of the results that is returned per call.

", "location":"querystring", "locationName":"maxResults" } @@ -6245,7 +6633,7 @@ }, "nextToken":{ "shape":"PaginationToken", - "documentation":"

The pagination token that's used to fetch the next set of results.

" + "documentation":"

The token value retrieved from a previous call to access the next page of results.

" } } }, @@ -7079,6 +7467,17 @@ "min":36, "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, + "ProtectedQueryMemberOutputConfiguration":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"

The unique identifier for the account.

" + } + }, + "documentation":"

Contains configuration details for the protected query member output.

" + }, "ProtectedQueryMemberOutputList":{ "type":"list", "member":{"shape":"ProtectedQuerySingleMemberOutput"} @@ -7103,7 +7502,11 @@ "members":{ "s3":{ "shape":"ProtectedQueryS3OutputConfiguration", - "documentation":"

Required configuration for a protected query with an `S3` output type.

" + "documentation":"

Required configuration for a protected query with an s3 output type.

" + }, + "member":{ + "shape":"ProtectedQueryMemberOutputConfiguration", + "documentation":"

Required configuration for a protected query with a member output type.

" } }, "documentation":"

Contains configuration details for protected query output.

", @@ -7210,7 +7613,7 @@ "members":{ "totalDurationInMillis":{ "shape":"Long", - "documentation":"

The duration of the Protected Query, from creation until query completion.

" + "documentation":"

The duration of the protected query, from creation until query completion.

" } }, "documentation":"

Contains statistics about the execution of the protected query.

" @@ -7234,7 +7637,8 @@ "membershipId", "membershipArn", "createTime", - "status" + "status", + "receiverConfigurations" ], "members":{ "id":{ @@ -7256,6 +7660,10 @@ "status":{ "shape":"ProtectedQueryStatus", "documentation":"

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

" + }, + "receiverConfigurations":{ + "shape":"ReceiverConfigurationsList", + "documentation":"

The receiver configuration.

" } }, "documentation":"

The protected query summary for the objects listed by the request.

" @@ -7310,6 +7718,29 @@ "type":"list", "member":{"shape":"TableAlias"} }, + "ReceiverAccountIds":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "ReceiverConfiguration":{ + "type":"structure", + "required":["analysisType"], + "members":{ + "analysisType":{ + "shape":"AnalysisType", + "documentation":"

The type of analysis for the protected query. The results of the query can be analyzed directly (DIRECT_ANALYSIS) or used as input into additional analyses (ADDITIONAL_ANALYSIS), such as a query that is a seed for a lookalike ML model.

" + }, + "configurationDetails":{ + "shape":"ConfigurationDetails", + "documentation":"

The configuration details of the receiver configuration.

" + } + }, + "documentation":"

The receiver configuration for a protected query.

" + }, + "ReceiverConfigurationsList":{ + "type":"list", + "member":{"shape":"ReceiverConfiguration"} + }, "ResourceAlias":{ "type":"string", "max":128, @@ -7421,7 +7852,7 @@ "members":{ "columns":{ "shape":"ColumnList", - "documentation":"

The columns for the relation that this schema represents.

" + "documentation":"

The columns for the relation this schema represents.

" }, "partitionKeys":{ "shape":"ColumnList", @@ -7429,11 +7860,11 @@ }, "analysisRuleTypes":{ "shape":"AnalysisRuleTypeList", - "documentation":"

The analysis rule types that are associated with the schema. Currently, only one entry is present.

" + "documentation":"

The analysis rule types associated with the schema. Currently, only one entry is present.

" }, "analysisMethod":{ "shape":"AnalysisMethod", - "documentation":"

The analysis method for the schema. The only valid value is currently DIRECT_QUERY.

" + "documentation":"

The analysis method for the schema. The only valid value is currently DIRECT_QUERY.

" }, "creatorAccountId":{ "shape":"AccountId", @@ -7449,7 +7880,7 @@ }, "collaborationArn":{ "shape":"CollaborationArn", - "documentation":"

The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

" + "documentation":"

The unique ARN for the collaboration that the schema belongs to.

" }, "description":{ "shape":"TableDescription", @@ -7457,15 +7888,15 @@ }, "createTime":{ "shape":"Timestamp", - "documentation":"

The time at which the schema was created.

" + "documentation":"

The time the schema was created.

" }, "updateTime":{ "shape":"Timestamp", - "documentation":"

The most recent time at which the schema was updated.

" + "documentation":"

The time the schema was last updated.

" }, "type":{ "shape":"SchemaType", - "documentation":"

The type of schema.

" + "documentation":"

The type of schema. The only valid value is currently `TABLE`.

" }, "schemaStatusDetails":{ "shape":"SchemaStatusDetailList", @@ -7510,13 +7941,7 @@ }, "SchemaConfiguration":{ "type":"string", - "enum":[ - "DIFFERENTIAL_PRIVACY", - "CUSTOM_ANALYSIS_NOT_ALLOWED", - "NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS", - "DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED", - "ID_MAPPING_TABLE_NOT_POPULATED" - ] + "enum":["DIFFERENTIAL_PRIVACY"] }, "SchemaConfigurationList":{ "type":"list", @@ -7537,11 +7962,14 @@ }, "SchemaStatusDetail":{ "type":"structure", - "required":["status"], + "required":[ + "status", + "analysisType" + ], "members":{ "status":{ "shape":"SchemaStatus", - "documentation":"

The status of the schema.

" + "documentation":"

The status of the schema, indicating if it is ready to query.

" }, "reasons":{ "shape":"SchemaStatusReasonList", @@ -7554,6 +7982,10 @@ "configurations":{ "shape":"SchemaConfigurationList", "documentation":"

The configuration details of the schema analysis rule for the given type.

" + }, + "analysisType":{ + "shape":"AnalysisType", + "documentation":"

The type of analysis that can be performed on the schema.

A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

" } }, "documentation":"

Information about the schema status.

A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.

" @@ -7587,7 +8019,13 @@ "ANALYSIS_TEMPLATES_NOT_CONFIGURED", "ANALYSIS_PROVIDERS_NOT_CONFIGURED", "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED", - "ID_MAPPING_TABLE_NOT_POPULATED" + "ID_MAPPING_TABLE_NOT_POPULATED", + "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED", + "ADDITIONAL_ANALYSES_NOT_CONFIGURED", + "RESULT_RECEIVERS_NOT_CONFIGURED", + "ADDITIONAL_ANALYSES_NOT_ALLOWED", + "RESULT_RECEIVERS_NOT_ALLOWED", + "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE" ] }, "SchemaStatusReasonList":{ @@ -7613,7 +8051,7 @@ }, "type":{ "shape":"SchemaType", - "documentation":"

The type of schema object.

" + "documentation":"

The type of schema object. The only valid schema type is currently `TABLE`.

" }, "creatorAccountId":{ "shape":"AccountId", @@ -7996,6 +8434,49 @@ } } }, + "UpdateConfiguredTableAssociationAnalysisRuleInput":{ + "type":"structure", + "required":[ + "membershipIdentifier", + "configuredTableAssociationIdentifier", + "analysisRuleType", + "analysisRulePolicy" + ], + "members":{ + "membershipIdentifier":{ + "shape":"MembershipIdentifier", + "documentation":"

A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

", + "location":"uri", + "locationName":"membershipIdentifier" + }, + "configuredTableAssociationIdentifier":{ + "shape":"ConfiguredTableAssociationIdentifier", + "documentation":"

The identifier for the configured table association to update.

", + "location":"uri", + "locationName":"configuredTableAssociationIdentifier" + }, + "analysisRuleType":{ + "shape":"ConfiguredTableAssociationAnalysisRuleType", + "documentation":"

The analysis rule type that you want to update.

", + "location":"uri", + "locationName":"analysisRuleType" + }, + "analysisRulePolicy":{ + "shape":"ConfiguredTableAssociationAnalysisRulePolicy", + "documentation":"

The updated analysis rule policy for the configured table association.

" + } + } + }, + "UpdateConfiguredTableAssociationAnalysisRuleOutput":{ + "type":"structure", + "required":["analysisRule"], + "members":{ + "analysisRule":{ + "shape":"ConfiguredTableAssociationAnalysisRule", + "documentation":"

The updated analysis rule for the configured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

" + } + } + }, "UpdateConfiguredTableAssociationInput":{ "type":"structure", "required":[ diff --git a/botocore/data/dynamodb/2012-08-10/service-2.json b/botocore/data/dynamodb/2012-08-10/service-2.json index d1a34493c5..9b95e4b201 100644 --- a/botocore/data/dynamodb/2012-08-10/service-2.json +++ b/botocore/data/dynamodb/2012-08-10/service-2.json @@ -27,7 +27,7 @@ {"shape":"RequestLimitExceeded"}, {"shape":"InternalServerError"} ], - "documentation":"

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

" + "documentation":"

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .

The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

" }, "BatchGetItem":{ "name":"BatchGetItem", @@ -62,7 +62,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:

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

For tables and indexes with provisioned capacity, 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. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException.

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:

", "endpointdiscovery":{ } }, @@ -193,7 +193,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.

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.

", + "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. For the full list of table states, see TableStatus.

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":{ } }, @@ -4800,7 +4800,7 @@ }, "ScannedCount":{ "shape":"Integer", - "documentation":"

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" + "documentation":"

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" }, "LastEvaluatedKey":{ "shape":"Key", diff --git a/botocore/data/iotsitewise/2019-12-02/service-2.json b/botocore/data/iotsitewise/2019-12-02/service-2.json index efc72d8ec2..725291f7ee 100644 --- a/botocore/data/iotsitewise/2019-12-02/service-2.json +++ b/botocore/data/iotsitewise/2019-12-02/service-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"iotsitewise", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS IoT SiteWise", "serviceId":"IoTSiteWise", "signatureVersion":"v4", "signingName":"iotsitewise", - "uid":"iotsitewise-2019-12-02" + "uid":"iotsitewise-2019-12-02", + "auth":["aws.auth#sigv4"] }, "operations":{ "AssociateAssets":{ @@ -438,6 +440,7 @@ "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictingOperationException"}, {"shape":"InternalFailureException"}, {"shape":"ThrottlingException"} ], @@ -1398,7 +1401,7 @@ {"shape":"ThrottlingException"}, {"shape":"ConflictingOperationException"} ], - "documentation":"

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

", + "documentation":"

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing asset model property with a new one with the same name, do the following:

  1. Submit an UpdateAssetModel request with the entire existing property removed.

  2. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

", "endpoint":{"hostPrefix":"api."} }, "UpdateAssetModelCompositeModel":{ @@ -2017,7 +2020,7 @@ "members":{ "id":{ "shape":"ID", - "documentation":"

The ID of the the composite model that this summary describes..

" + "documentation":"

The ID of the composite model that this summary describes..

" }, "externalId":{ "shape":"ExternalId", @@ -2025,15 +2028,15 @@ }, "name":{ "shape":"Name", - "documentation":"

The name of the the composite model that this summary describes..

" + "documentation":"

The name of the composite model that this summary describes..

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

The type of asset model.

" + "documentation":"

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

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

The description of the the composite model that this summary describes..

" + "documentation":"

The description of the composite model that this summary describes..

" }, "path":{ "shape":"AssetModelCompositeModelPath", @@ -3469,7 +3472,7 @@ }, "CapabilityConfiguration":{ "type":"string", - "max":104857600, + "max":10000000, "min":1 }, "CapabilityNamespace":{ @@ -3484,7 +3487,8 @@ "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", - "UNKNOWN" + "UNKNOWN", + "NOT_APPLICABLE" ] }, "ClientToken":{ @@ -3690,7 +3694,8 @@ "CoreDeviceThingName":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"^[a-zA-Z0-9:_-]+$" }, "CreateAccessPolicyRequest":{ "type":"structure", @@ -3772,7 +3777,7 @@ }, "assetModelCompositeModelName":{ "shape":"Name", - "documentation":"

A unique, friendly name for the composite model.

" + "documentation":"

A unique name for the composite model.

" }, "assetModelCompositeModelType":{ "shape":"Name", @@ -3785,11 +3790,11 @@ }, "composedAssetModelId":{ "shape":"CustomID", - "documentation":"

The ID of a composite model on this asset.

" + "documentation":"

The ID of a component model which is reused to create this composite model.

" }, "assetModelCompositeModelProperties":{ "shape":"AssetModelPropertyDefinitions", - "documentation":"

The property definitions of the composite model. For more information, see <LINK>.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" + "documentation":"

The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" } } }, @@ -3818,7 +3823,7 @@ "members":{ "assetModelName":{ "shape":"Name", - "documentation":"

A unique, friendly name for the asset model.

" + "documentation":"

A unique name for the asset model.

" }, "assetModelDescription":{ "shape":"Description", @@ -3834,7 +3839,7 @@ }, "assetModelCompositeModels":{ "shape":"AssetModelCompositeModelDefinitions", - "documentation":"

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

" + "documentation":"

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

" }, "clientToken":{ "shape":"ClientToken", @@ -4063,8 +4068,8 @@ ], "members":{ "gatewayName":{ - "shape":"Name", - "documentation":"

A unique, friendly name for the gateway.

" + "shape":"GatewayName", + "documentation":"

A unique name for the gateway.

" }, "gatewayPlatform":{ "shape":"GatewayPlatform", @@ -5276,7 +5281,7 @@ "documentation":"

The ID of the gateway device.

" }, "gatewayName":{ - "shape":"Name", + "shape":"GatewayName", "documentation":"

The name of the gateway.

" }, "gatewayArn":{ @@ -5938,6 +5943,12 @@ }, "documentation":"

Contains a summary of a gateway capability configuration.

" }, + "GatewayName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[^\\u0000-\\u001F\\u007F]+" + }, "GatewayPlatform":{ "type":"structure", "members":{ @@ -5948,6 +5959,10 @@ "greengrassV2":{ "shape":"GreengrassV2", "documentation":"

A gateway that runs on IoT Greengrass V2.

" + }, + "siemensIE":{ + "shape":"SiemensIE", + "documentation":"

A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

" } }, "documentation":"

Contains a gateway's platform information.

" @@ -5970,8 +5985,8 @@ "documentation":"

The ID of the gateway device.

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

The name of the asset.

" + "shape":"GatewayName", + "documentation":"

The name of the gateway.

" }, "gatewayPlatform":{"shape":"GatewayPlatform"}, "gatewayCapabilitySummaries":{ @@ -6303,7 +6318,7 @@ "members":{ "groupArn":{ "shape":"ARN", - "documentation":"

The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference.

" + "documentation":"

The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.

" } }, "documentation":"

Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

" @@ -6513,6 +6528,12 @@ "error":{"httpStatusCode":400}, "exception":true }, + "IotCoreThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9:_-]+$" + }, "JobConfiguration":{ "type":"structure", "required":["fileFormat"], @@ -8075,6 +8096,17 @@ "exception":true, "fault":true }, + "SiemensIE":{ + "type":"structure", + "required":["iotCoreThingName"], + "members":{ + "iotCoreThingName":{ + "shape":"IotCoreThingName", + "documentation":"

The name of the IoT Thing for your SiteWise Edge gateway.

" + } + }, + "documentation":"

Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

" + }, "StorageType":{ "type":"string", "enum":[ @@ -8424,7 +8456,7 @@ }, "assetModelCompositeModelName":{ "shape":"Name", - "documentation":"

A unique, friendly name for the composite model.

" + "documentation":"

A unique name for the composite model.

" }, "clientToken":{ "shape":"ClientToken", @@ -8433,7 +8465,7 @@ }, "assetModelCompositeModelProperties":{ "shape":"AssetModelProperties", - "documentation":"

The property definitions of the composite model. For more information, see <LINK>.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" + "documentation":"

The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

" } } }, @@ -8466,7 +8498,7 @@ }, "assetModelName":{ "shape":"Name", - "documentation":"

A unique, friendly name for the asset model.

" + "documentation":"

A unique name for the asset model.

" }, "assetModelDescription":{ "shape":"Description", @@ -8482,7 +8514,7 @@ }, "assetModelCompositeModels":{ "shape":"AssetModelCompositeModels", - "documentation":"

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

" + "documentation":"

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

" }, "clientToken":{ "shape":"ClientToken", @@ -8678,8 +8710,8 @@ "locationName":"gatewayId" }, "gatewayName":{ - "shape":"Name", - "documentation":"

A unique, friendly name for the gateway.

" + "shape":"GatewayName", + "documentation":"

A unique name for the gateway.

" } } }, @@ -8832,7 +8864,7 @@ }, "integerValue":{ "shape":"PropertyValueIntegerValue", - "documentation":"

Asset property data of type integer (number that's greater than or equal to zero).

" + "documentation":"

Asset property data of type integer (whole number).

" }, "doubleValue":{ "shape":"PropertyValueDoubleValue", diff --git a/botocore/data/mediapackagev2/2022-12-25/service-2.json b/botocore/data/mediapackagev2/2022-12-25/service-2.json index 250b9ffaa3..09aab1a184 100644 --- a/botocore/data/mediapackagev2/2022-12-25/service-2.json +++ b/botocore/data/mediapackagev2/2022-12-25/service-2.json @@ -2,7 +2,6 @@ "version":"2.0", "metadata":{ "apiVersion":"2022-12-25", - "auth":["aws.auth#sigv4"], "endpointPrefix":"mediapackagev2", "protocol":"rest-json", "protocols":["rest-json"], @@ -1269,7 +1268,8 @@ "CLEAR_KEY_AES_128", "FAIRPLAY", "PLAYREADY", - "WIDEVINE" + "WIDEVINE", + "IRDETO" ] }, "Encryption":{ diff --git a/botocore/data/medical-imaging/2023-07-19/service-2.json b/botocore/data/medical-imaging/2023-07-19/service-2.json index d62ce0e024..4f4168da52 100644 --- a/botocore/data/medical-imaging/2023-07-19/service-2.json +++ b/botocore/data/medical-imaging/2023-07-19/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2023-07-19", + "auth":["aws.auth#sigv4"], "endpointPrefix":"medical-imaging", "protocol":"rest-json", "protocols":["rest-json"], @@ -390,6 +391,10 @@ "min":12, "pattern":"\\d+" }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ClientToken":{ "type":"string", "max":64, @@ -409,6 +414,12 @@ }, "exception":true }, + "CopiableAttributes":{ + "type":"string", + "max":260000, + "min":1, + "sensitive":true + }, "CopyDestinationImageSet":{ "type":"structure", "required":[ @@ -503,6 +514,12 @@ "copyImageSetInformation":{ "shape":"CopyImageSetInformation", "documentation":"

Copy image set information.

" + }, + "force":{ + "shape":"Boolean", + "documentation":"

Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet.

", + "location":"querystring", + "locationName":"force" } }, "payload":"copyImageSetInformation" @@ -536,6 +553,10 @@ "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest version identifier for the source image set.

" + }, + "DICOMCopies":{ + "shape":"MetadataCopies", + "documentation":"

Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.

" } }, "documentation":"

Copy source image set information.

" @@ -620,7 +641,7 @@ }, "DICOMAccessionNumber":{ "type":"string", - "max":16, + "max":256, "min":0, "sensitive":true }, @@ -740,7 +761,7 @@ }, "DICOMNumberOfStudyRelatedSeries":{ "type":"integer", - "max":10000, + "max":1000000, "min":0 }, "DICOMPatientBirthDate":{ @@ -751,7 +772,7 @@ }, "DICOMPatientId":{ "type":"string", - "max":64, + "max":256, "min":0, "sensitive":true }, @@ -775,9 +796,9 @@ }, "DICOMSeriesInstanceUID":{ "type":"string", - "max":64, + "max":256, "min":0, - "pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", "sensitive":true }, "DICOMSeriesModality":{ @@ -828,9 +849,9 @@ }, "DICOMStudyInstanceUID":{ "type":"string", - "max":64, + "max":256, "min":0, - "pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", + "pattern":"(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", "sensitive":true }, "DICOMStudyTime":{ @@ -1321,6 +1342,10 @@ "imageSetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) assigned to the image set.

" + }, + "overrides":{ + "shape":"Overrides", + "documentation":"

This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.

" } } }, @@ -1390,6 +1415,10 @@ "message":{ "shape":"Message", "documentation":"

The error message thrown if an image set action fails.

" + }, + "overrides":{ + "shape":"Overrides", + "documentation":"

Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.

" } }, "documentation":"

The image set properties.

" @@ -1668,12 +1697,27 @@ "min":1, "pattern":"[\\w -:]+" }, + "MetadataCopies":{ + "type":"structure", + "required":["copiableAttributes"], + "members":{ + "copiableAttributes":{ + "shape":"CopiableAttributes", + "documentation":"

The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.

" + } + }, + "documentation":"

Contains copiable Attributes structure and wraps information related to specific copy use cases. For example, when copying subsets.

" + }, "MetadataUpdates":{ "type":"structure", "members":{ "DICOMUpdates":{ "shape":"DICOMUpdates", "documentation":"

The object containing removableAttributes and updatableAttributes.

" + }, + "revertToVersionId":{ + "shape":"ImageSetExternalVersionId", + "documentation":"

Specifies the previous image set version ID to revert the current image set back to.

You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.

" } }, "documentation":"

Contains DICOMUpdates.

", @@ -1692,6 +1736,16 @@ "BETWEEN" ] }, + "Overrides":{ + "type":"structure", + "members":{ + "forced":{ + "shape":"Boolean", + "documentation":"

Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.

" + } + }, + "documentation":"

Specifies the overrides used in image set modification calls to CopyImageSet and UpdateImageSetMetadata.

" + }, "PayloadBlob":{ "type":"blob", "streaming":true @@ -2087,6 +2141,12 @@ "location":"querystring", "locationName":"latestVersion" }, + "force":{ + "shape":"Boolean", + "documentation":"

Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

", + "location":"querystring", + "locationName":"force" + }, "updateImageSetMetadataUpdates":{ "shape":"MetadataUpdates", "documentation":"

Update image set metadata updates.

" diff --git a/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json b/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json index 1d37990f92..9701c2bc27 100644 --- a/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json +++ b/botocore/data/pinpoint-sms-voice-v2/2022-03-31/service-2.json @@ -2,9 +2,11 @@ "version":"2.0", "metadata":{ "apiVersion":"2022-03-31", + "auth":["aws.auth#sigv4"], "endpointPrefix":"sms-voice", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceFullName":"Amazon Pinpoint SMS Voice V2", "serviceId":"Pinpoint SMS Voice V2", "signatureVersion":"v4", @@ -85,7 +87,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

" + "documentation":"

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.

" }, "CreateOptOutList":{ "name":"CreateOptOutList", @@ -103,7 +105,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

" + "documentation":"

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide.

" }, "CreatePool":{ "name":"CreatePool", @@ -334,7 +336,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords \"HELP\" and \"STOP\" can't be deleted or modified.

" + "documentation":"

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.

Keywords \"HELP\" and \"STOP\" can't be deleted or modified.

" }, "DeleteMediaMessageSpendLimitOverride":{ "name":"DeleteMediaMessageSpendLimitOverride", @@ -492,7 +494,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

" + "documentation":"

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.

" }, "DeleteVerifiedDestinationNumber":{ "name":"DeleteVerifiedDestinationNumber", @@ -526,7 +528,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

" + "documentation":"

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", @@ -542,7 +544,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

" + "documentation":"

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

" }, "DescribeAccountLimits":{ "name":"DescribeAccountLimits", @@ -558,7 +560,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

" + "documentation":"

Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide.

" }, "DescribeConfigurationSets":{ "name":"DescribeConfigurationSets", @@ -592,7 +594,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

" + "documentation":"

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

" }, "DescribeOptOutLists":{ "name":"DescribeOptOutLists", @@ -826,7 +828,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

" + "documentation":"

Describes the current monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.

" }, "DescribeVerifiedDestinationNumbers":{ "name":"DescribeVerifiedDestinationNumbers", @@ -984,7 +986,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

" + "documentation":"

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

" }, "PutOptedOutNumber":{ "name":"PutOptedOutNumber", @@ -1074,7 +1076,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

" + "documentation":"

Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.

" }, "RequestSenderId":{ "name":"RequestSenderId", @@ -1149,7 +1151,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates a new text message and sends it to a recipient's phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

" + "documentation":"

Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.

" }, "SendVoiceMessage":{ "name":"SendVoiceMessage", @@ -1168,7 +1170,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

" + "documentation":"

Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.

" }, "SetAccountDefaultProtectConfiguration":{ "name":"SetAccountDefaultProtectConfiguration", @@ -1303,7 +1305,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

" + "documentation":"

Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.

" }, "UntagResource":{ "name":"UntagResource", @@ -1320,7 +1322,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

" + "documentation":"

Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.

" }, "UpdateEventDestination":{ "name":"UpdateEventDestination", @@ -1338,7 +1340,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

" + "documentation":"

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.

" }, "UpdatePhoneNumber":{ "name":"UpdatePhoneNumber", @@ -1922,7 +1924,7 @@ }, "MatchingEventTypes":{ "shape":"EventTypeList", - "documentation":"

An array of event types that determine which events to log. If \"ALL\" is used, then Amazon Pinpoint logs every event type.

The TEXT_SENT event type is not supported.

" + "documentation":"

An array of event types that determine which events to log. If \"ALL\" is used, then AWS End User Messaging SMS and Voice logs every event type.

The TEXT_SENT event type is not supported.

" }, "CloudWatchLogsDestination":{ "shape":"CloudWatchLogsDestination", @@ -1930,7 +1932,7 @@ }, "KinesisFirehoseDestination":{ "shape":"KinesisFirehoseDestination", - "documentation":"

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

" + "documentation":"

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

" }, "SnsDestination":{ "shape":"SnsDestination", @@ -2010,7 +2012,7 @@ "members":{ "OriginationIdentity":{ "shape":"PhoneOrSenderIdOrArn", - "documentation":"

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

" + "documentation":"

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

" }, "IsoCountryCode":{ "shape":"IsoCountryCode", @@ -2018,7 +2020,7 @@ }, "MessageType":{ "shape":"MessageType", - "documentation":"

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

" + "documentation":"

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.

" }, "DeletionProtectionEnabled":{ "shape":"Boolean", @@ -2068,7 +2070,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -2076,7 +2078,7 @@ }, "SharedRoutesEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

Indicates whether shared routes are enabled for the pool.

" + "documentation":"

Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.

" }, "DeletionProtectionEnabled":{ "shape":"PrimitiveBoolean", @@ -2739,7 +2741,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -3933,14 +3935,14 @@ }, "KinesisFirehoseDestination":{ "shape":"KinesisFirehoseDestination", - "documentation":"

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

" + "documentation":"

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

" }, "SnsDestination":{ "shape":"SnsDestination", "documentation":"

An object that contains information about an event destination that sends logging events to Amazon SNS.

" } }, - "documentation":"

Contains information about an event destination.

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

" + "documentation":"

Contains information about an event destination.

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

" }, "EventDestinationList":{ "type":"list", @@ -4085,7 +4087,7 @@ }, "CountryRuleSet":{ "shape":"ProtectConfigurationCountryRuleSet", - "documentation":"

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

" + "documentation":"

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.

" } } }, @@ -4209,14 +4211,14 @@ "members":{ "IamRoleArn":{ "shape":"IamRoleArn", - "documentation":"

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

" + "documentation":"

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

" }, "DeliveryStreamArn":{ "shape":"DeliveryStreamArn", "documentation":"

The Amazon Resource Name (ARN) of the delivery stream.

" } }, - "documentation":"

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

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

" + "documentation":"

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

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

" }, "LanguageCode":{ "type":"string", @@ -4723,7 +4725,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

" + "documentation":"

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -4858,7 +4860,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

" + "documentation":"

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -4866,7 +4868,7 @@ }, "SharedRoutesEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

" + "documentation":"

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

" }, "DeletionProtectionEnabled":{ "shape":"PrimitiveBoolean", @@ -5958,7 +5960,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -6137,7 +6139,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -6498,11 +6500,11 @@ }, "MaxPrice":{ "shape":"MaxPrice", - "documentation":"

The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

" + "documentation":"

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

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

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

" + "documentation":"

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

" }, "Context":{ "shape":"ContextMap", @@ -6510,11 +6512,11 @@ }, "DestinationCountryParameters":{ "shape":"DestinationCountryParameters", - "documentation":"

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

" + "documentation":"

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

" }, "DryRun":{ "shape":"PrimitiveBoolean", - "documentation":"

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

" + "documentation":"

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

" }, "ProtectConfigurationId":{ "shape":"ProtectConfigurationIdOrArn", @@ -6615,7 +6617,7 @@ "documentation":"

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

" } }, - "documentation":"

The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.

" + "documentation":"

The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide.

" }, "SenderIdFilter":{ "type":"structure", @@ -6949,7 +6951,7 @@ "documentation":"

When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

" } }, - "documentation":"

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

" + "documentation":"

Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide.

" }, "SpendLimitList":{ "type":"list", @@ -7223,7 +7225,7 @@ }, "KinesisFirehoseDestination":{ "shape":"KinesisFirehoseDestination", - "documentation":"

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

" + "documentation":"

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

" }, "SnsDestination":{ "shape":"SnsDestination", @@ -7270,7 +7272,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"Boolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListNameOrArn", @@ -7377,7 +7379,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"Boolean", - "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListNameOrArn", @@ -7426,7 +7428,7 @@ }, "SelfManagedOptOutsEnabled":{ "shape":"PrimitiveBoolean", - "documentation":"

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" + "documentation":"

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

" }, "OptOutListName":{ "shape":"OptOutListName", @@ -7464,7 +7466,7 @@ }, "CountryRuleSetUpdates":{ "shape":"ProtectConfigurationCountryRuleSet", - "documentation":"

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

" + "documentation":"

A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.

" } } }, @@ -7926,5 +7928,5 @@ "pattern":"[A-Za-z0-9_:/\\+-]+" } }, - "documentation":"

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

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

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

Regional availability

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

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

" + "documentation":"

Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

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

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

Regional availability

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

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

" } From af496bf80312e02b499dc88e4b6044474a4836e5 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 24 Jul 2024 18:17:23 +0000 Subject: [PATCH 2/3] Update endpoints model --- botocore/data/endpoints.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 7ed4272e4d..a91017603c 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -28325,7 +28325,8 @@ }, "apigateway" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "appconfig" : { @@ -29201,6 +29202,11 @@ "us-isob-east-1" : { } } }, + "apigateway" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "appconfig" : { "endpoints" : { "us-isob-east-1" : { } From 0bfddb9536cbf557f4d3b0e5d7496d7c0e525b8b Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 24 Jul 2024 18:18:12 +0000 Subject: [PATCH 3/3] Bumping version to 1.34.148 --- .changes/1.34.148.json | 32 +++++++++++++++++++ .../api-change-cleanrooms-28554.json | 5 --- .../api-change-dynamodb-74256.json | 5 --- .../api-change-iotsitewise-35719.json | 5 --- .../api-change-mediapackagev2-46553.json | 5 --- .../api-change-medicalimaging-65420.json | 5 --- .../api-change-pinpointsmsvoicev2-43299.json | 5 --- CHANGELOG.rst | 11 +++++++ botocore/__init__.py | 2 +- docs/source/conf.py | 2 +- 10 files changed, 45 insertions(+), 32 deletions(-) create mode 100644 .changes/1.34.148.json delete mode 100644 .changes/next-release/api-change-cleanrooms-28554.json delete mode 100644 .changes/next-release/api-change-dynamodb-74256.json delete mode 100644 .changes/next-release/api-change-iotsitewise-35719.json delete mode 100644 .changes/next-release/api-change-mediapackagev2-46553.json delete mode 100644 .changes/next-release/api-change-medicalimaging-65420.json delete mode 100644 .changes/next-release/api-change-pinpointsmsvoicev2-43299.json diff --git a/.changes/1.34.148.json b/.changes/1.34.148.json new file mode 100644 index 0000000000..b21c0f1964 --- /dev/null +++ b/.changes/1.34.148.json @@ -0,0 +1,32 @@ +[ + { + "category": "``cleanrooms``", + "description": "Three enhancements to the AWS Clean Rooms: Disallowed Output Columns, Flexible Result Receivers, SQL as a Seed", + "type": "api-change" + }, + { + "category": "``dynamodb``", + "description": "DynamoDB doc only update for July", + "type": "api-change" + }, + { + "category": "``iotsitewise``", + "description": "Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device.", + "type": "api-change" + }, + { + "category": "``mediapackagev2``", + "description": "This release adds support for Irdeto DRM encryption in DASH manifests.", + "type": "api-change" + }, + { + "category": "``medical-imaging``", + "description": "CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter.", + "type": "api-change" + }, + { + "category": "``pinpoint-sms-voice-v2``", + "description": "Update for rebrand to AWS End User Messaging SMS and Voice.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/api-change-cleanrooms-28554.json b/.changes/next-release/api-change-cleanrooms-28554.json deleted file mode 100644 index 39d28c56f5..0000000000 --- a/.changes/next-release/api-change-cleanrooms-28554.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``cleanrooms``", - "description": "Three enhancements to the AWS Clean Rooms: Disallowed Output Columns, Flexible Result Receivers, SQL as a Seed" -} diff --git a/.changes/next-release/api-change-dynamodb-74256.json b/.changes/next-release/api-change-dynamodb-74256.json deleted file mode 100644 index 3b5e664389..0000000000 --- a/.changes/next-release/api-change-dynamodb-74256.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``dynamodb``", - "description": "DynamoDB doc only update for July" -} diff --git a/.changes/next-release/api-change-iotsitewise-35719.json b/.changes/next-release/api-change-iotsitewise-35719.json deleted file mode 100644 index b547afc336..0000000000 --- a/.changes/next-release/api-change-iotsitewise-35719.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``iotsitewise``", - "description": "Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device." -} diff --git a/.changes/next-release/api-change-mediapackagev2-46553.json b/.changes/next-release/api-change-mediapackagev2-46553.json deleted file mode 100644 index f37ab90f74..0000000000 --- a/.changes/next-release/api-change-mediapackagev2-46553.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``mediapackagev2``", - "description": "This release adds support for Irdeto DRM encryption in DASH manifests." -} diff --git a/.changes/next-release/api-change-medicalimaging-65420.json b/.changes/next-release/api-change-medicalimaging-65420.json deleted file mode 100644 index 75a4e87618..0000000000 --- a/.changes/next-release/api-change-medicalimaging-65420.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``medical-imaging``", - "description": "CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter." -} diff --git a/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json b/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json deleted file mode 100644 index 99aec2c817..0000000000 --- a/.changes/next-release/api-change-pinpointsmsvoicev2-43299.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "api-change", - "category": "``pinpoint-sms-voice-v2``", - "description": "Update for rebrand to AWS End User Messaging SMS and Voice." -} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 6d48a21ba1..991c9eaa73 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,17 @@ CHANGELOG ========= +1.34.148 +======== + +* api-change:``cleanrooms``: Three enhancements to the AWS Clean Rooms: Disallowed Output Columns, Flexible Result Receivers, SQL as a Seed +* api-change:``dynamodb``: DynamoDB doc only update for July +* api-change:``iotsitewise``: Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device. +* api-change:``mediapackagev2``: This release adds support for Irdeto DRM encryption in DASH manifests. +* api-change:``medical-imaging``: CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter. +* api-change:``pinpoint-sms-voice-v2``: Update for rebrand to AWS End User Messaging SMS and Voice. + + 1.34.147 ======== diff --git a/botocore/__init__.py b/botocore/__init__.py index 6d8c5c067a..d103abd57c 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.34.147' +__version__ = '1.34.148' class NullHandler(logging.Handler): diff --git a/docs/source/conf.py b/docs/source/conf.py index 7c3de9d06f..058ed4bb2d 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.147' +release = '1.34.148' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.